[SCM] calf/master: Add Doxygen documentation for plugin_registry class.

js at users.alioth.debian.org js at users.alioth.debian.org
Tue May 7 15:39:58 UTC 2013


The following commit has been merged in the master branch:
commit 4c093bf60cc6257232927d907106551293913384
Author: Krzysztof Foltman <wdev at foltman.com>
Date:   Fri Apr 2 23:18:52 2010 +0100

    Add Doxygen documentation for plugin_registry class.

diff --git a/src/calf/giface.h b/src/calf/giface.h
index a968995..36ab043 100644
--- a/src/calf/giface.h
+++ b/src/calf/giface.h
@@ -377,6 +377,7 @@ struct plugin_ctl_iface: public virtual plugin_metadata_iface
 
 struct plugin_list_info_iface;
 
+/// A class to retrieve and query the list of Calf plugins
 class plugin_registry
 {
 public:
@@ -385,9 +386,12 @@ private:
     plugin_vector plugins;
     plugin_registry();
 public:
+    /// Get the singleton object.
     static plugin_registry &instance();
 
+    /// Get all plugin metadata objects
     const plugin_vector &get_all() { return plugins; }
+    /// Get single plugin metadata object by URI
     const plugin_metadata_iface *get_by_uri(const char *URI);
 };
 

-- 
calf audio plugins packaging



More information about the pkg-multimedia-commits mailing list