update documentation for ComponentBroker, so it is clear who owns ins…

…tance
yast · Oct 2, 2013 · b411f04 · b411f04
1 parent d500928
commit b411f04
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/liby2/src/include/y2/Y2ComponentBroker.h b/liby2/src/include/y2/Y2ComponentBroker.h
@@ -156,6 +156,10 @@ class Y2ComponentBroker
      * If set to false only servers are created.
      * @return A pointer to the new component if one has been found, 0 if no
      * component matching spec has been found.
+     * Pointer returned by this function is owned by ComponentCreator so do not
+     * delete it at your own.
+     * @see Y2ComponentCreator#create for details what ComponentCreator must
+     * return
      */
     static Y2Component *createComponent(const char *name, bool look_for_clients);