gplugin/gplugin

fix up the loader docs to include all symbols
feature/gtk-doc
2017-07-31, Gary Kramlich
3098195671ff
Parents feb82bb53711
Children 0a7ae375f787
fix up the loader docs to include all symbols
--- a/gplugin/gplugin-loader.c Mon Jul 31 22:16:33 2017 -0500
+++ b/gplugin/gplugin-loader.c Mon Jul 31 22:17:50 2017 -0500
@@ -19,6 +19,16 @@
#include <gplugin/gplugin-core.h>
+/**
+ * SECTION:gplugin-loader
+ * @Title: Plugin Loader Interface
+ * @Short_description: interface for loading plugins
+ *
+ * A PluginLoader has to implement the interface described here for GPlugin to
+ * be able to use it to load plugins.
+ */
+
+
/******************************************************************************
* API
*****************************************************************************/
@@ -48,7 +58,10 @@
* gplugin_loader_query_plugin:
* @loader: #GPluginLoader instance performing the query
* @filename: filename to query
- * error: return location for a GError, or NULL
+ * @error: return location for a GError, or NULL
+ *
+ * This function is called by the plugin manager to ask a loader to query the
+ * given file and determine if it's a usable plugin.
*
* Return value: (transfer full): A #GPluginPlugin instance or NULL on failure
*/
@@ -75,7 +88,10 @@
* gplugin_loader_load_plugin:
* @loader: #GPluginLoader instance performing the load
* @plugin: #GPluginPlugin instance to load
- * error: return location for a GError, or NULL
+ * @error: return location for a GError, or NULL
+ *
+ * This function is called by the plugin manager to ask a loader to load the
+ * given plugin.
*
* Return value: TRUE if @plugin was loaded successfully, FALSE otherwise
*/
@@ -110,6 +126,9 @@
* @plugin: #GPluginPlugin instance to unload
* @error: return location for a GError, or NULL
*
+ * This function is called by the plugin manager to ask a loader to unload the
+ * given plugin.
+ *
* Return value: TRUE if @plugin was unloaded successfully, FALSE otherwise
*/
gboolean