[libpeas] Fix a few documentation warnings

[Garrett Regier <gregier src gnome org>]

commit 425701197654ea65014a8d9a848d4b22938efc3b
Author: Garrett Regier <alias301 gmail com>
Date:   Sat Jun 11 15:41:37 2011 -0700

    Fix a few documentation warnings

 libpeas-gtk/peas-gtk-plugin-manager-view.h |    6 +++
 libpeas-gtk/peas-gtk-plugin-manager.h      |    6 +++
 libpeas/peas-engine.c                      |   14 ++++++
 libpeas/peas-object-module.c               |   62 +++++++++++++++++++++++----
 libpeas/peas-object-module.h               |    5 ++-
 libpeas/peas-plugin-info.h                 |    3 +
 6 files changed, 85 insertions(+), 11 deletions(-)
---
diff --git a/libpeas-gtk/peas-gtk-plugin-manager-view.h b/libpeas-gtk/peas-gtk-plugin-manager-view.h
index 4699bd2..4308797 100644
--- a/libpeas-gtk/peas-gtk-plugin-manager-view.h
+++ b/libpeas-gtk/peas-gtk-plugin-manager-view.h
@@ -44,6 +44,12 @@ typedef struct _PeasGtkPluginManagerView        PeasGtkPluginManagerView;
 typedef struct _PeasGtkPluginManagerViewClass   PeasGtkPluginManagerViewClass;
 typedef struct _PeasGtkPluginManagerViewPrivate PeasGtkPluginManagerViewPrivate;
 
+/**
+ * PeasGtkPluginManagerView:
+ *
+ * The #PeasGtkPluginManagerView structure contains only private data
+ * and should only be accessed using the provided API.
+ */
 struct _PeasGtkPluginManagerView {
   GtkTreeView parent;
 
diff --git a/libpeas-gtk/peas-gtk-plugin-manager.h b/libpeas-gtk/peas-gtk-plugin-manager.h
index eb868ca..8565f6e 100644
--- a/libpeas-gtk/peas-gtk-plugin-manager.h
+++ b/libpeas-gtk/peas-gtk-plugin-manager.h
@@ -41,6 +41,12 @@ typedef struct _PeasGtkPluginManager        PeasGtkPluginManager;
 typedef struct _PeasGtkPluginManagerClass   PeasGtkPluginManagerClass;
 typedef struct _PeasGtkPluginManagerPrivate PeasGtkPluginManagerPrivate;
 
+/**
+ * PeasGtkPluginManager:
+ *
+ * The #PeasGtkPluginManager structure contains only private data
+ * and should only be accessed using the provided API.
+ */
 struct _PeasGtkPluginManager
 {
   GtkBox box;
diff --git a/libpeas/peas-engine.c b/libpeas/peas-engine.c
index 805e88a..3e19fd3 100644
--- a/libpeas/peas-engine.c
+++ b/libpeas/peas-engine.c
@@ -734,6 +734,9 @@ compare_plugin_info_and_name (PeasPluginInfo *info,
  * @engine: A #PeasEngine.
  * @plugin_name: A plugin name.
  *
+ * Gets the #PeasPluginInfo corresponding with @plugin_name,
+ * or %NULL if @plugin_name was not found.
+ *
  * Returns: the #PeasPluginInfo corresponding with
  * a given plugin module name.
  */
@@ -940,6 +943,17 @@ peas_engine_unload_plugin (PeasEngine     *engine,
   return !peas_plugin_info_is_loaded (info);
 }
 
+/**
+ * peas_engine_provides_extension:
+ * @engine: A #PeasEngine.
+ * @info: A #PeasPluginInfo.
+ * @extension_type: The extension #GType.
+ *
+ * Returns if @info provides an extension for @extension_type.
+ * If the @info is not loaded than %FALSE will always be returned.
+ *
+ * Returns: if @info provides an extension for @extension_type.
+ */
 gboolean
 peas_engine_provides_extension (PeasEngine     *engine,
                                 PeasPluginInfo *info,
diff --git a/libpeas/peas-object-module.c b/libpeas/peas-object-module.c
index eb9ea60..b4295ef 100644
--- a/libpeas/peas-object-module.c
+++ b/libpeas/peas-object-module.c
@@ -268,6 +268,16 @@ peas_object_module_class_init (PeasObjectModuleClass *klass)
   g_type_class_add_private (klass, sizeof (PeasObjectModulePrivate));
 }
 
+/**
+ * peas_object_module_new: (skip)
+ * @module_name: The module name.
+ * @path: The path.
+ * @resident: If the module should be resident.
+ *
+ * Creates a new #PeasObjectModule.
+ *
+ * Return value: a new #PeasObjectModule.
+ */
 PeasObjectModule *
 peas_object_module_new (const gchar *module_name,
                         const gchar *path,
@@ -281,13 +291,18 @@ peas_object_module_new (const gchar *module_name,
 }
 
 /**
- * peas_object_module_create_object:
- * @module:
- * @interface:
- * @n_parameters:
- * @parameters:
+ * peas_object_module_create_object: (skip)
+ * @module: A #PeasObjectModule.
+ * @interface: The #GType of the extension interface.
+ * @n_parameters: The number of paramteters.
+ * @parameters: (array length=n_parameters): The parameters.
+ *
+ * Creates an object for the @interface passing @n_parameters
+ * and @parameters to the #PeasFactoryFunc. If @module does
+ * not provide a #PeasFactoryFunc for @interface then
+ * %NULL is returned.
  *
- * Return value: (transfer full):
+ * Return value: (transfer full): The created object, or %NULL.
  */
 GObject *
 peas_object_module_create_object (PeasObjectModule *module,
@@ -308,6 +323,15 @@ peas_object_module_create_object (PeasObjectModule *module,
   return NULL;
 }
 
+/**
+ * peas_object_module_provides_object: (skip)
+ * @module: A #PeasObjectModule.
+ * @interface: The #GType of the extension interface.
+ *
+ * Determines if the module provides an extension for @interface.
+ *
+ * Return value: if the module provides an extension for @interface.
+ */
 gboolean
 peas_object_module_provides_object (PeasObjectModule *module,
                                     GType             interface)
@@ -325,6 +349,14 @@ peas_object_module_provides_object (PeasObjectModule *module,
   return FALSE;
 }
 
+/**
+ * peas_object_module_get_path: (skip)
+ * @module: A #PeasObjectModule.
+ *
+ * Gets the path.
+ *
+ * Return value: the path.
+ */
 const gchar *
 peas_object_module_get_path (PeasObjectModule *module)
 {
@@ -333,6 +365,14 @@ peas_object_module_get_path (PeasObjectModule *module)
   return module->priv->path;
 }
 
+/**
+ * peas_object_module_get_module_name: (skip)
+ * @module: A #PeasObjectModule.
+ *
+ * Gets the module name.
+ *
+ * Return value: the module name.
+ */
 const gchar *
 peas_object_module_get_module_name (PeasObjectModule *module)
 {
@@ -343,9 +383,11 @@ peas_object_module_get_module_name (PeasObjectModule *module)
 
 /**
  * peas_object_module_get_library: (skip)
- * @module:
+ * @module: A #PeasObjectModule.
+ *
+ * Gets the library.
  *
- * Return value:
+ * Return value: the library.
  */
 GModule *
 peas_object_module_get_library (PeasObjectModule *module)
@@ -356,7 +398,7 @@ peas_object_module_get_library (PeasObjectModule *module)
 }
 
 /**
- * peas_object_module_register_extension_factory:
+ * peas_object_module_register_extension_factory: (skip)
  * @module: Your plugin's #PeasObjectModule.
  * @iface_type: The #GType of the extension interface you implement.
  * @factory_func: The #PeasFactoryFunc that will create the @iface_type
@@ -423,7 +465,7 @@ create_gobject_from_type (guint       n_parameters,
 }
 
 /**
- * peas_object_module_register_extension_type:
+ * peas_object_module_register_extension_type: (skip)
  * @module: Your plugin's #PeasObjectModule.
  * @iface_type: The #GType of the extension interface you implement.
  * @extension_type: The #GType of your implementation of @iface_type.
diff --git a/libpeas/peas-object-module.h b/libpeas/peas-object-module.h
index 6368f01..c6f9e38 100644
--- a/libpeas/peas-object-module.h
+++ b/libpeas/peas-object-module.h
@@ -43,13 +43,16 @@ typedef struct _PeasObjectModulePrivate  PeasObjectModulePrivate;
 
 /**
  * PeasFactoryFunc:
+ * @n_parameters: The number of paramteters.
+ * @parameters: (array length=n_parameters): The parameters.
+ * @user_data: Optional data to be passed to the function, or %NULL.
  *
  * A #PeasFactoryFunc is a factory function which will instanciate a new
  * extension of a given type. g_object_newv() is such a function.
  *
  * It is used with peas_object_module_register_object_factory().
  *
- * Return value: (transfer full):
+ * Return value: (transfer full): The created object.
  */
 typedef GObject *(*PeasFactoryFunc)   (guint          n_parameters,
                                        GParameter    *parameters,
diff --git a/libpeas/peas-plugin-info.h b/libpeas/peas-plugin-info.h
index 075fbb9..d1335d2 100644
--- a/libpeas/peas-plugin-info.h
+++ b/libpeas/peas-plugin-info.h
@@ -49,6 +49,9 @@ G_BEGIN_DECLS
  *      A dependancy of the plugin was not found.
  * @PEAS_PLUGIN_INFO_ERROR_DEP_LOADING_FAILED:
  *      A dependancy of the plugin failed to load.
+ *
+ * These identify the various errors that can occur while
+ * loading a plugin.
  */
 typedef enum {
   PEAS_PLUGIN_INFO_ERROR_LOADING_FAILED,