Changeset 5433:6a6c001574c0 in roaraudio for include

Timestamp:

03/20/12 13:31:32 (12 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

updated comments

File:

• include/libroar/plugincontainer.h (modified) (2 diffs)

include/libroar/plugincontainer.h

@@ -44 +44 @@
 struct roar_plugincontainer * roar_plugincontainer_new(struct roar_dl_librarypara * default_para);
 #endif
+
+/* Create a new plugin container.
+ * Takes host application's appname and abiversion.
+ */
 struct roar_plugincontainer * roar_plugincontainer_new_simple(const char * appname, const char * abiversion);
 
+// Increment the refrence counter.
 int roar_plugincontainer_ref(struct roar_plugincontainer * cont);
+/* Decrement the refrence counter.
+ * Unloads all plugins and frees all resources when there are no refreneces left.
+ */
 int roar_plugincontainer_unref(struct roar_plugincontainer * cont);
 
 /*
  * stuff we still need:
- * object creation, load plugin, get plugin handle, setting search path.
+ * object creation, get plugin handle.
  */
 
 // plugin loading and unloading:
+
+// Load a plugin by name.
 int                      roar_plugincontainer_load            (struct roar_plugincontainer * cont,
                                                                const char * name,
                                                                struct roar_dl_librarypara * para);
+
+/* Load a plugin by name with extra options.
+ * This is for advanced applications only.
+ */
 struct roar_dl_lhandle * roar_plugincontainer_load_lhandle    (struct roar_plugincontainer * cont,
                                                                const char * name,
@@ -63 +77 @@
                                                                int ra_init,
                                                                struct roar_dl_librarypara * para);
+/* Unload a plugin by name.
+ * NOTE: The name here is from the plugin and may not match the name you load
+ *       the plugin with.
+ */
 int                      roar_plugincontainer_unload          (struct roar_plugincontainer * cont,
                                                                const char * name);
+/* Load a plugin by roardl handle.
+ * This is for advanced applications only.
+ */
 int                      roar_plugincontainer_unload_lhandle  (struct roar_plugincontainer * cont,
                                                                struct roar_dl_lhandle * lhandle);
+/* Post ra_init plugins not yet inited.
+ * NOTE: This uses the default para,
+ *       not the one given with roar_plugincontainer_load_lhandle().
+ * This is for advanced applications only.
+ */
 int                      roar_plugincontainer_ra_init         (struct roar_plugincontainer * cont);
 
 // appsched:
+// Trigger an application schedule event on all plugins.
 int                      roar_plugincontainer_appsched_trigger(struct roar_plugincontainer * cont, enum roar_dl_appsched_trigger trigger);