[libpeas] Fix all undocumented symbols



commit 174c88472de5183e477b1fb537fd721d114440fa
Author: Garrett Regier <garrettregier gmail com>
Date:   Sun Aug 28 05:06:21 2011 -0700

    Fix all undocumented symbols

 libpeas-gtk/peas-gtk-configurable.h        |   12 ++++++++++++
 libpeas-gtk/peas-gtk-plugin-manager-view.h |    9 +++++++++
 libpeas-gtk/peas-gtk-plugin-manager.h      |    7 +++++++
 libpeas/peas-activatable.h                 |   15 +++++++++++++++
 libpeas/peas-engine.h                      |    9 +++++++++
 libpeas/peas-extension-base.h              |    7 +++++++
 libpeas/peas-extension-set.h               |   14 ++++++++++++++
 libpeas/peas-extension.h                   |    5 +++++
 libpeas/peas-object-module.h               |    7 +++++++
 9 files changed, 85 insertions(+), 0 deletions(-)
---
diff --git a/libpeas-gtk/peas-gtk-configurable.h b/libpeas-gtk/peas-gtk-configurable.h
index e177f50..c51dc20 100644
--- a/libpeas-gtk/peas-gtk-configurable.h
+++ b/libpeas-gtk/peas-gtk-configurable.h
@@ -35,9 +35,21 @@ G_BEGIN_DECLS
 #define PEAS_GTK_IS_CONFIGURABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PEAS_GTK_TYPE_CONFIGURABLE))
 #define PEAS_GTK_CONFIGURABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), PEAS_GTK_TYPE_CONFIGURABLE, PeasGtkConfigurableInterface))
 
+/**
+ * PeasGtkConfigurable:
+ *
+ * Interface for configurable plugins.
+ */
 typedef struct _PeasGtkConfigurable           PeasGtkConfigurable; /* dummy typedef */
 typedef struct _PeasGtkConfigurableInterface  PeasGtkConfigurableInterface;
 
+/**
+ * PeasGtkConfigurableInterface:
+ * @g_iface: The parent interface.
+ * @create_configure_widget: Creates the configure widget for the plugin.
+ *
+ * Provides an interface for configurable plugins.
+ */
 struct _PeasGtkConfigurableInterface
 {
   GTypeInterface g_iface;
diff --git a/libpeas-gtk/peas-gtk-plugin-manager-view.h b/libpeas-gtk/peas-gtk-plugin-manager-view.h
index ba552e6..2c9f1bd 100644
--- a/libpeas-gtk/peas-gtk-plugin-manager-view.h
+++ b/libpeas-gtk/peas-gtk-plugin-manager-view.h
@@ -57,12 +57,21 @@ struct _PeasGtkPluginManagerView {
   PeasGtkPluginManagerViewPrivate *priv;
 };
 
+/**
+ * PeasGtkPluginManagerViewClass:
+ * @parent_class: The parent class.
+ * @populate_popup: Signal class handler for the
+ *                  #PeasGtkPluginManagerView::populate-popup signal.
+ *
+ * The class structure for #PeasGtkPluginManagerView.
+ */
 struct _PeasGtkPluginManagerViewClass {
   GtkTreeViewClass parent_class;
 
   void  (*populate_popup)   (PeasGtkPluginManagerView *view,
                              GtkMenu                  *menu);
 
+  /*< private >*/
   gpointer padding[8];
 };
 
diff --git a/libpeas-gtk/peas-gtk-plugin-manager.h b/libpeas-gtk/peas-gtk-plugin-manager.h
index 12db1a0..bde4efe 100644
--- a/libpeas-gtk/peas-gtk-plugin-manager.h
+++ b/libpeas-gtk/peas-gtk-plugin-manager.h
@@ -55,10 +55,17 @@ struct _PeasGtkPluginManager
   PeasGtkPluginManagerPrivate *priv;
 };
 
+/**
+ * PeasGtkPluginManagerClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #PeasGtkPluginManager.
+ */
 struct _PeasGtkPluginManagerClass
 {
   GtkBoxClass parent_class;
 
+  /*< private >*/
   gpointer padding[8];
 };
 
diff --git a/libpeas/peas-activatable.h b/libpeas/peas-activatable.h
index 9ea8259..f7673e0 100644
--- a/libpeas/peas-activatable.h
+++ b/libpeas/peas-activatable.h
@@ -35,9 +35,24 @@ G_BEGIN_DECLS
 #define PEAS_IS_ACTIVATABLE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PEAS_TYPE_ACTIVATABLE))
 #define PEAS_ACTIVATABLE_GET_IFACE(obj)   (G_TYPE_INSTANCE_GET_INTERFACE ((obj), PEAS_TYPE_ACTIVATABLE, PeasActivatableInterface))
 
+/**
+ * PeasActivatable:
+ *
+ * Interface for activatable plugins.
+ */
 typedef struct _PeasActivatable           PeasActivatable; /* dummy typedef */
 typedef struct _PeasActivatableInterface  PeasActivatableInterface;
 
+/**
+ * PeasActivatableInterface:
+ * @g_iface: The parent interface.
+ * @activate: Activates the plugin.
+ * @deactivate: Deactivates the plugin.
+ * @update_state: Updates the plugin's internal state to take account of
+ *  a change in the target object's state.
+ *
+ * Provides an interface for activatable plugins.
+ */
 struct _PeasActivatableInterface {
   GTypeInterface g_iface;
 
diff --git a/libpeas/peas-engine.h b/libpeas/peas-engine.h
index 31c6d8f..dae2180 100644
--- a/libpeas/peas-engine.h
+++ b/libpeas/peas-engine.h
@@ -57,6 +57,14 @@ struct _PeasEngine {
   PeasEnginePrivate *priv;
 };
 
+/**
+ * PeasEngineClass:
+ * @parent_class: The parent class.
+ * @load_plugin: Signal class handler for the #PeasEngine::load-plugin signal.
+ * @unload_plugin: Signal class handler for the #PeasEngine::unload-plugin signal.
+ *
+ * Class structure for #PeasEngine.
+ */
 struct _PeasEngineClass {
   GObjectClass parent_class;
 
@@ -66,6 +74,7 @@ struct _PeasEngineClass {
   void     (*unload_plugin)               (PeasEngine     *engine,
                                            PeasPluginInfo *info);
 
+  /*< private >*/
   gpointer padding[8];
 };
 
diff --git a/libpeas/peas-extension-base.h b/libpeas/peas-extension-base.h
index ede92cf..a53e723 100644
--- a/libpeas/peas-extension-base.h
+++ b/libpeas/peas-extension-base.h
@@ -53,9 +53,16 @@ struct _PeasExtensionBase {
   PeasExtensionBasePrivate *priv;
 };
 
+/**
+ * PeasExtensionBaseClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure of #PeasExtensionBase.
+ */
 struct _PeasExtensionBaseClass {
   GObjectClass parent_class;
 
+  /*< private >*/
   gpointer padding[8];
 };
 
diff --git a/libpeas/peas-extension-set.h b/libpeas/peas-extension-set.h
index da41dea..af97a84 100644
--- a/libpeas/peas-extension-set.h
+++ b/libpeas/peas-extension-set.h
@@ -53,6 +53,17 @@ struct _PeasExtensionSet {
   PeasExtensionSetPrivate *priv;
 };
 
+/**
+ * PeasExtensionSetClass:
+ * @parent_class: The parent class.
+ * @call: The VFunc for peas_extension_set_call().
+ * @extension_added: Signal class handler for the
+ *                   #PeasExtensionSet::extension-added signal.
+ * @extension_removed: Signal class handler for the
+ *                   #PeasExtensionSet::extension-removed signal.
+ *
+ * The class structure for #PeasExtensionSet.
+ */
 struct _PeasExtensionSetClass {
   GObjectClass parent_class;
 
@@ -62,9 +73,11 @@ struct _PeasExtensionSetClass {
                                            const gchar      *method_name,
                                            GIArgument       *args);
 #else
+  /*< private >*/
   gpointer __DEPRECATED_call;
 #endif
 
+  /*< public >*/
   /* Signals */
   void       (*extension_added)           (PeasExtensionSet *set,
                                            PeasPluginInfo   *info,
@@ -73,6 +86,7 @@ struct _PeasExtensionSetClass {
                                            PeasPluginInfo   *info,
                                            PeasExtension    *exten);
 
+  /*< private >*/
   gpointer padding[8];
 };
 
diff --git a/libpeas/peas-extension.h b/libpeas/peas-extension.h
index 7551a6a..05c700c 100644
--- a/libpeas/peas-extension.h
+++ b/libpeas/peas-extension.h
@@ -34,6 +34,11 @@ G_BEGIN_DECLS
 #define PEAS_EXTENSION(obj)            (G_OBJECT(obj))
 #define PEAS_IS_EXTENSION(obj)         (G_IS_OBJECT(obj))
 
+/**
+ * PeasExtension:
+ *
+ * A proxy class to access the actual plugin.
+ */
 typedef GObject PeasExtension;
 
 /*
diff --git a/libpeas/peas-object-module.h b/libpeas/peas-object-module.h
index ca5f8d4..78ccb57 100644
--- a/libpeas/peas-object-module.h
+++ b/libpeas/peas-object-module.h
@@ -70,9 +70,16 @@ struct _PeasObjectModule {
   PeasObjectModulePrivate *priv;
 };
 
+/**
+ * PeasObjectModuleClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #PeasObjectModule.
+ */
 struct _PeasObjectModuleClass {
   GTypeModuleClass parent_class;
 
+  /*< private >*/
   gpointer padding[8];
 };
 



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