Doc for Store::execute_hooks_for_mut_file()

2017-02-20 16:05:17 +01:00 · 2017-02-20 16:05:17 +01:00 · 602bdd9762
commit 602bdd9762
parent 0c3cea692f
1 changed files with 6 additions and 0 deletions
--- a/libimagstore/src/store.rs
+++ b/libimagstore/src/store.rs
@ -1005,6 +1005,12 @@ impl Store {
    }

    /// Execute all hooks from all aspects for a mutable `FileLockEntry` object.
+    ///
+    /// # Return value
+    ///
+    /// - () on success
+    /// - Error on the first failing hook.
+    ///
    fn execute_hooks_for_mut_file(&self,
                                  aspects: Arc<Mutex<Vec<Aspect>>>,
                                  fle: &mut FileLockEntry)