GNOME.org
 

[libpeas] Annotation and documentation fixes

commit fa99fd61b071c3d735f3b669714d1a7b1061f73b
Author: Garrett Regier <alias301 gmail com>
Date:   Wed Jan 19 02:50:51 2011 -0800

    Annotation and documentation fixes

 libpeas-gtk/peas-gtk-configurable.c                |    4 ++--
 libpeas-gtk/peas-gtk-plugin-manager-store.c        |    2 +-
 libpeas-gtk/peas-gtk-plugin-manager-view.c         |    6 +++---
 libpeas-gtk/peas-gtk-plugin-manager.c              |    4 ++--
 libpeas/peas-activatable.c                         |    6 +++---
 libpeas/peas-engine.c                              |    6 +++---
 libpeas/peas-extension-base.c                      |    5 +++--
 libpeas/peas-extension.c                           |    9 +++++++--
 libpeas/peas-plugin-info.c                         |    6 +++---
 .../libpeas/introspection/introspection-callable.c |    2 +-
 10 files changed, 28 insertions(+), 22 deletions(-)
---
diff --git a/libpeas-gtk/peas-gtk-configurable.c b/libpeas-gtk/peas-gtk-configurable.c
index cbad7c0..35812ae 100644
--- a/libpeas-gtk/peas-gtk-configurable.c
+++ b/libpeas-gtk/peas-gtk-configurable.c
@@ -27,7 +27,7 @@
 
 /**
  * SECTION:peas-gtk-configurable
- * @short_description: Interface to provide a plugin configuration UI
+ * @short_description: Interface for providing a plugin configuration UI.
  *
  * The #PeasGtkConfigurable interface will allow a plugin to provide a
  * graphical interface for the user to configure the plugin through the
@@ -51,7 +51,7 @@ peas_gtk_configurable_default_init (PeasGtkConfigurableInterface *iface)
  * peas_gtk_configurable_create_configure_widget:
  * @configurable: A #PeasGtkConfigurable
  *
- * Creates the configure widget widget for the plugin. The returned widget
+ * Creates the configure widget for the plugin. The returned widget
  * should allow configuring all the relevant aspects of the plugin, and should
  * allow instant-apply, as promoted by the Gnome Human Interface Guidelines.
  *
diff --git a/libpeas-gtk/peas-gtk-plugin-manager-store.c b/libpeas-gtk/peas-gtk-plugin-manager-store.c
index 32b0eee..8109e43 100644
--- a/libpeas-gtk/peas-gtk-plugin-manager-store.c
+++ b/libpeas-gtk/peas-gtk-plugin-manager-store.c
@@ -239,7 +239,7 @@ peas_gtk_plugin_manager_store_class_init (PeasGtkPluginManagerStoreClass *klass)
 /*
  * peas_gtk_plugin_manager_store_new:
  *
- * Creates a new plugin manager store for the given #PeasEngine.
+ * Creates a new plugin manager store.
  *
  * Returns: the new #PeasGtkPluginManagerStore.
  */
diff --git a/libpeas-gtk/peas-gtk-plugin-manager-view.c b/libpeas-gtk/peas-gtk-plugin-manager-view.c
index 4f8e7d3..546ff5c 100644
--- a/libpeas-gtk/peas-gtk-plugin-manager-view.c
+++ b/libpeas-gtk/peas-gtk-plugin-manager-view.c
@@ -42,7 +42,7 @@
  * plugins, i.e. load or unload them, and see some pieces of information.
  *
  * The only thing you need to do as an application writer if you wish
- * to use the view to configure your plugins is to instantiate it using
+ * to use the view to display your plugins is to instantiate it using
  * peas_gtk_plugin_manager_view_new() and pack it into another
  * widget or a window.
  *
@@ -650,7 +650,7 @@ peas_gtk_plugin_manager_view_class_init (PeasGtkPluginManagerViewClass *klass)
   tree_view_class->row_activated = peas_gtk_plugin_manager_view_row_activated;
 
   /**
-   * PeasGtkPLuginManagerView:show-builtin:
+   * PeasGtkPluginManagerView:show-builtin:
    *
    * If builtin plugins should be shown.
    */
@@ -689,7 +689,7 @@ peas_gtk_plugin_manager_view_class_init (PeasGtkPluginManagerViewClass *klass)
 /**
  * peas_gtk_plugin_manager_view_new:
  *
- * Creates a new plugin manager view for the given #PeasEngine.
+ * Creates a new plugin manager view.
  *
  * Returns: the new #PeasGtkPluginManagerView.
  */
diff --git a/libpeas-gtk/peas-gtk-plugin-manager.c b/libpeas-gtk/peas-gtk-plugin-manager.c
index c371f0b..54a7097 100644
--- a/libpeas-gtk/peas-gtk-plugin-manager.c
+++ b/libpeas-gtk/peas-gtk-plugin-manager.c
@@ -482,7 +482,7 @@ peas_gtk_plugin_manager_class_init (PeasGtkPluginManagerClass *klass)
 /**
  * peas_gtk_plugin_manager_new:
  *
- * Creates a new plugin manager for the given #PeasEngine.
+ * Creates a new plugin manager.
  *
  * Returns: the new #PeasGtkPluginManager.
  */
@@ -495,7 +495,7 @@ peas_gtk_plugin_manager_new (void)
 
 /**
  * peas_gtk_plugin_manager_get_view:
- * @pm: A @PeasGtkPluginManager.
+ * @pm: A #PeasGtkPluginManager.
  *
  * Returns the #PeasGtkPluginManagerView of @pm.
  *
diff --git a/libpeas/peas-activatable.c b/libpeas/peas-activatable.c
index 85169d2..864468e 100644
--- a/libpeas/peas-activatable.c
+++ b/libpeas/peas-activatable.c
@@ -27,13 +27,13 @@
 
 /**
  * SECTION:peas-activatable
- * @short_description: Interface for activatable extensions
+ * @short_description: Interface for activatable plugins.
  * @see_also: #PeasExtensionSet
  *
- * #PeasActivatable is an interface which should be implemented by extensions
+ * #PeasActivatable is an interface which should be implemented by plugins
  * that should be activated on an object of a certain type (depending on the
  * application). For instance, in a typical windowed application,
- * #PeasActivatable extension instances could be bound to individual toplevel
+ * #PeasActivatable plugin instances could be bound to individual toplevel
  * windows.
  *
  * It is typical to use #PeasActivatable along with #PeasExtensionSet in order
diff --git a/libpeas/peas-engine.c b/libpeas/peas-engine.c
index f446c6c..0294fc0 100644
--- a/libpeas/peas-engine.c
+++ b/libpeas/peas-engine.c
@@ -172,8 +172,8 @@ load_dir_real (PeasEngine  *engine,
  *
  * Rescan all the registered directories to find new or updated plugins.
  *
- * Calling this function will make the newly installed plugin infos to be
- * loaded by the engine, so the new plugins can actually be used without
+ * Calling this function will make the newly installed plugin infos
+ * be loaded by the engine, so the new plugins can be used without
  * restarting the application.
  */
 void
@@ -212,7 +212,7 @@ peas_engine_rescan_plugins (PeasEngine *engine)
  * module directory (where the shared libraries or language modules
  * lie) and a data directory (where the plugin data is).
  *
- * The #PeasPlugin will be able to use a correct data dir depending on
+ * The plugin will be able to use a correct data dir depending on
  * where it is installed, hence allowing to keep the plugin agnostic
  * when it comes to installation location: the same plugin can be
  * installed either in the system path or in the user's home directory,
diff --git a/libpeas/peas-extension-base.c b/libpeas/peas-extension-base.c
index 88c58b4..f4cd29f 100644
--- a/libpeas/peas-extension-base.c
+++ b/libpeas/peas-extension-base.c
@@ -30,7 +30,7 @@
 
 /**
  * SECTION:peas-extension-base
- * @short_description: Base class for C extensions
+ * @short_description: Base class for C extensions.
  * @see_also: #PeasPluginInfo
  *
  * #PeasExtensionBase can optionally be used as a base class for the extensions
@@ -132,7 +132,8 @@ peas_extension_base_class_init (PeasExtensionBaseClass *klass)
                                    PROP_DATA_DIR,
                                    g_param_spec_string ("data-dir",
                                                         "Data Directory",
-                                                        "The full path of the directory where the plugin should look for its data files",
+                                                        "The full path of the directory where the "
+                                                        "plugin should look for its data files",
                                                         NULL,
                                                         G_PARAM_READABLE |
                                                         G_PARAM_STATIC_STRINGS));
diff --git a/libpeas/peas-extension.c b/libpeas/peas-extension.c
index 815ce08..e5820d9 100644
--- a/libpeas/peas-extension.c
+++ b/libpeas/peas-extension.c
@@ -38,7 +38,7 @@
  * loaded plugins.
  *
  * To properly use the proxy instances, you will need GObject-introspection
- * data for the #GInterface or #GObjectClass you want to use as extension
+ * data for the #GInterface or #GObjectClass you want to use as an extension
  * point.  For instance, if you wish to use #PeasActivatable, you will need to
  * put the following code excerpt in the engine initialization code, in order
  * to load the required "Peas" typelib:
@@ -136,10 +136,15 @@ peas_extension_class_init (PeasExtensionClass *klass)
   object_class->get_property = peas_extension_get_property;
   object_class->constructed = peas_extension_constructed;
 
+  /**
+   * PeasExtension:extension-type:
+   *
+   * The GType of the interface being proxied.
+   */
   g_object_class_install_property (object_class, PROP_EXTENSION_TYPE,
                                    g_param_spec_gtype ("extension-type",
                                                        "Extension Type",
-                                                       "The GType of this extesion",
+                                                       "The GType of the interface being proxied",
                                                        G_TYPE_NONE,
                                                        G_PARAM_READWRITE |
                                                        G_PARAM_CONSTRUCT_ONLY |
diff --git a/libpeas/peas-plugin-info.c b/libpeas/peas-plugin-info.c
index 4cfb1d4..6dd94a7 100644
--- a/libpeas/peas-plugin-info.c
+++ b/libpeas/peas-plugin-info.c
@@ -381,7 +381,7 @@ peas_plugin_info_is_available (const PeasPluginInfo *info)
  * peas_plugin_info_is_builtin:
  * @info: A #PeasPluginInfo.
  *
- * Gets is the plugin is a builtin plugin.
+ * Check if the plugin is a builtin plugin.
  *
  * A builtin plugin is a plugin which cannot be enabled or disabled by the
  * user through a plugin manager (like #PeasGtkPluginManager). Loading or
@@ -664,8 +664,8 @@ peas_plugin_info_get_version (const PeasPluginInfo *info)
  * website or a ghelp: URI if a Gnome help page is available for the plugin.
  *
  * The relevant key in the plugin info file is "Help". Other platform-specific
- * keys exist for platform-specific help files. Those are "Help-Gnome",
- * "Help-Windows" and "Help-MacOs-X".
+ * keys exist for platform-specific help files. Those are "Help-GNOME",
+ * "Help-Windows" and "Help-MacOS-X".
  *
  * Returns: the plugin's help URI.
  */
diff --git a/tests/libpeas/introspection/introspection-callable.c b/tests/libpeas/introspection/introspection-callable.c
index 80b5bc6..112b6bb 100644
--- a/tests/libpeas/introspection/introspection-callable.c
+++ b/tests/libpeas/introspection/introspection-callable.c
@@ -36,7 +36,7 @@ introspection_callable_default_init (IntrospectionCallableInterface *iface)
  * introspection_callable_call_with_return:
  * @callable:
  *
- * Returns: (transfer full):
+ * Returns: (transfer none):
  */
 const gchar *
 introspection_callable_call_with_return (IntrospectionCallable *callable)
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]