[libpeas] Cleanup the docs a bit



commit cd8ddb38cf85e6ed5c81048b0b3e1a12d5bf6599
Author: Garrett Regier <garrettregier gmail com>
Date:   Thu Sep 1 17:00:22 2011 -0700

    Cleanup the docs a bit

 libpeas-gtk/peas-gtk-plugin-manager-view.c |    8 +++++---
 libpeas/peas-engine.h                      |    5 -----
 libpeas/peas-extension-set.c               |   14 ++++++--------
 libpeas/peas-extension.c                   |   16 ++++++++--------
 libpeas/peas-plugin-info.h                 |    6 +++---
 5 files changed, 22 insertions(+), 27 deletions(-)
---
diff --git a/libpeas-gtk/peas-gtk-plugin-manager-view.c b/libpeas-gtk/peas-gtk-plugin-manager-view.c
index 2ac2910..7eb7361 100644
--- a/libpeas-gtk/peas-gtk-plugin-manager-view.c
+++ b/libpeas-gtk/peas-gtk-plugin-manager-view.c
@@ -782,6 +782,8 @@ peas_gtk_plugin_manager_view_class_init (PeasGtkPluginManagerViewClass *klass)
    * PeasGtkPluginManagerView:show-builtin:
    *
    * If builtin plugins should be shown.
+   *
+   * Deprecated: 1.2: Use hidden plugins instead.
    */
   g_object_class_install_property (object_class,
                                    PROP_SHOW_BUILTIN,
@@ -800,7 +802,7 @@ peas_gtk_plugin_manager_view_class_init (PeasGtkPluginManagerViewClass *klass)
    * @view: A #PeasGtkPluginManagerView.
    * @menu: A #GtkMenu.
    *
-   * The populate-popup signal is emitted before showing the context
+   * The ::populate-popup signal is emitted before showing the context
    * menu of the view. If you need to add items to the context menu,
    * connect to this signal and add your menuitems to the @menu.
    */
@@ -845,7 +847,7 @@ peas_gtk_plugin_manager_view_new (PeasEngine *engine)
  *
  * Sets if builtin plugins should be shown.
  *
- * Deprecated: 1.2. Use hidden plugins instead.
+ * Deprecated: 1.2: Use hidden plugins instead.
  */
 void
 peas_gtk_plugin_manager_view_set_show_builtin (PeasGtkPluginManagerView *view,
@@ -907,7 +909,7 @@ peas_gtk_plugin_manager_view_set_show_builtin (PeasGtkPluginManagerView *view,
  *
  * Returns: if builtin plugins should be shown.
  *
- * Deprecated: 1.2. Use hidden plugins instead.
+ * Deprecated: 1.2: Use hidden plugins instead.
  */
 gboolean
 peas_gtk_plugin_manager_view_get_show_builtin (PeasGtkPluginManagerView *view)
diff --git a/libpeas/peas-engine.h b/libpeas/peas-engine.h
index dae2180..eb77142 100644
--- a/libpeas/peas-engine.h
+++ b/libpeas/peas-engine.h
@@ -35,11 +35,6 @@ G_BEGIN_DECLS
 #define PEAS_IS_ENGINE_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), PEAS_TYPE_ENGINE))
 #define PEAS_ENGINE_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS((obj), PEAS_TYPE_ENGINE, PeasEngineClass))
 
-/**
- * PeasEngine:
- *
- * Engine at the heart of the Peas plugin system.
- */
 typedef struct _PeasEngine         PeasEngine;
 typedef struct _PeasEngineClass    PeasEngineClass;
 typedef struct _PeasEnginePrivate  PeasEnginePrivate;
diff --git a/libpeas/peas-extension-set.c b/libpeas/peas-extension-set.c
index 4089ea9..8f3f9fb 100644
--- a/libpeas/peas-extension-set.c
+++ b/libpeas/peas-extension-set.c
@@ -128,7 +128,7 @@ enum {
 };
 
 static void
-set_construct_properties (PeasExtensionSet *set,
+set_construct_properties (PeasExtensionSet   *set,
                           PeasParameterArray *array)
 {
   unsigned i;
@@ -464,7 +464,7 @@ peas_extension_set_get_extension (PeasExtensionSet *set,
 }
 
 /**
- * peas_extension_set_call: (skip)
+ * peas_extension_set_call:
  * @set: A #PeasExtensionSet.
  * @method_name: the name of the method that should be called.
  * @...: arguments for the method.
@@ -473,7 +473,7 @@ peas_extension_set_get_extension (PeasExtensionSet *set,
  *
  * See peas_extension_call() for more information.
  *
- * Deprecated: 1.2. Use peas_extension_set_foreach() instead.
+ * Deprecated: 1.2: Use peas_extension_set_foreach() instead.
  *
  * Return value: %TRUE on successful call.
  */
@@ -496,7 +496,7 @@ peas_extension_set_call (PeasExtensionSet *set,
 }
 
 /**
- * peas_extension_set_call_valist: (skip)
+ * peas_extension_set_call_valist:
  * @set: A #PeasExtensionSet.
  * @method_name: the name of the method that should be called.
  * @va_args: the arguments for the method.
@@ -505,7 +505,7 @@ peas_extension_set_call (PeasExtensionSet *set,
  *
  * See peas_extension_call_valist() for more information.
  *
- * Deprecated: 1.2. Use peas_extension_set_foreach() instead.
+ * Deprecated: 1.2: Use peas_extension_set_foreach() instead.
  *
  * Return value: %TRUE on successful call.
  */
@@ -550,9 +550,7 @@ peas_extension_set_call_valist (PeasExtensionSet *set,
  *
  * Return value: %TRUE on successful call.
  *
- * Deprecated: 1.2. Use peas_extension_set_foreach() instead.
- *
- * Rename to: peas_extension_set_call
+ * Deprecated: 1.2: Use peas_extension_set_foreach() instead.
  */
 gboolean
 peas_extension_set_callv (PeasExtensionSet *set,
diff --git a/libpeas/peas-extension.c b/libpeas/peas-extension.c
index a72833e..ee2bfb5 100644
--- a/libpeas/peas-extension.c
+++ b/libpeas/peas-extension.c
@@ -74,6 +74,8 @@ peas_extension_get_type (void)
  * Get the type of the extension interface of the object proxied by @exten.
  *
  * Return value: The #GType proxied by @exten.
+ *
+ * Deprecated: 1.2.
  */
 GType
 peas_extension_get_extension_type (PeasExtension *exten)
@@ -89,7 +91,7 @@ peas_extension_get_extension_type (PeasExtension *exten)
 }
 
 /**
- * peas_extension_call: (skip)
+ * peas_extension_call:
  * @exten: A #PeasExtension.
  * @method_name: the name of the method that should be called.
  * @...: arguments for the method.
@@ -112,7 +114,7 @@ peas_extension_get_extension_type (PeasExtension *exten)
  *
  * Return value: %TRUE on successful call.
  *
- * Deprecated: 1.2. Use the dynamically implemented interface instead.
+ * Deprecated: 1.2: Use the dynamically implemented interface instead.
  */
 gboolean
 peas_extension_call (PeasExtension *exten,
@@ -133,7 +135,7 @@ peas_extension_call (PeasExtension *exten,
 }
 
 /**
- * peas_extension_call_valist: (skip)
+ * peas_extension_call_valist:
  * @exten: A #PeasExtension.
  * @method_name: the name of the method that should be called.
  * @args: the arguments for the method.
@@ -144,7 +146,7 @@ peas_extension_call (PeasExtension *exten,
  *
  * Return value: %TRUE on successful call.
  *
- * Deprecated: 1.2. Use the dynamically implemented interface instead.
+ * Deprecated: 1.2: Use the dynamically implemented interface instead.
  */
 gboolean
 peas_extension_call_valist (PeasExtension *exten,
@@ -198,11 +200,9 @@ peas_extension_call_valist (PeasExtension *exten,
  *
  * See peas_extension_call() for more information.
  *
- * Return value: (transfer full): %TRUE on successful call.
- *
- * Deprecated: 1.2. Use the dynamically implemented interface instead.
+ * Return value: %TRUE on successful call.
  *
- * Rename to: peas_extension_call
+ * Deprecated: 1.2: Use the dynamically implemented interface instead.
  */
 gboolean
 peas_extension_callv (PeasExtension *exten,
diff --git a/libpeas/peas-plugin-info.h b/libpeas/peas-plugin-info.h
index 74109ec..3d95a32 100644
--- a/libpeas/peas-plugin-info.h
+++ b/libpeas/peas-plugin-info.h
@@ -34,7 +34,7 @@ G_BEGIN_DECLS
  * PEAS_PLUGIN_INFO_ERROR:
  *
  * Error domain for PeasPluginInfo. Errors in this domain will
- * be from the PeasPluginInfoError enumeration. See GError for
+ * be from the PeasPluginInfoError enumeration. See #GError for
  * more information on error domains.
  */
 #define PEAS_PLUGIN_INFO_ERROR peas_plugin_info_error_quark ()
@@ -46,9 +46,9 @@ G_BEGIN_DECLS
  * @PEAS_PLUGIN_INFO_ERROR_LOADER_NOT_FOUND:
  *      The plugin's loader was not found.
  * @PEAS_PLUGIN_INFO_ERROR_DEP_NOT_FOUND:
- *      A dependancy of the plugin was not found.
+ *      A dependency of the plugin was not found.
  * @PEAS_PLUGIN_INFO_ERROR_DEP_LOADING_FAILED:
- *      A dependancy of the plugin failed to load.
+ *      A dependency of the plugin failed to load.
  *
  * These identify the various errors that can occur while
  * loading a plugin.



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]