Doc for Store::execute_hooks_for_id()

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

    /// Execute all hooks from all aspects for a Store Id object.
+    ///
+    /// # Return value
+    ///
+    /// - () on success
+    /// - Error on the first failing hook.
+    ///
    fn execute_hooks_for_id(&self,
                            aspects: Arc<Mutex<Vec<Aspect>>>,
                            id: &StoreId)