/soc/2013/ankitkv/gobjectification: af1ec3eb15f5: Merge gtkdoc-c...

Ankit Vani a at nevitus.org
Sun Feb 2 14:38:09 EST 2014


Changeset: af1ec3eb15f58a3f0c8bcf226a5ab1d9d82e879d
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-03 01:06 +0530
Branch:	 soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/af1ec3eb15f5

Description:

Merge gtkdoc-conversion

diffstat:

 doc/reference/finch/finch-docs.xml         |  48 ++++++++++++++++-------------
 doc/reference/libpurple/libpurple-docs.xml |   1 +
 doc/reference/pidgin/pidgin-docs.xml       |   1 +
 finch/gntblist.h                           |   6 ++-
 finch/libgnt/gntcolors.h                   |   2 +-
 finch/libgnt/gntmain.c                     |   3 +
 finch/libgnt/gntutils.h                    |   8 ++--
 finch/libgnt/gntwidget.c                   |   7 ----
 finch/libgnt/gntwidget.h                   |   3 +
 finch/libgnt/gntwm.h                       |   7 +++-
 10 files changed, 49 insertions(+), 37 deletions(-)

diffs (247 lines):

diff --git a/doc/reference/finch/finch-docs.xml b/doc/reference/finch/finch-docs.xml
--- a/doc/reference/finch/finch-docs.xml
+++ b/doc/reference/finch/finch-docs.xml
@@ -13,58 +13,63 @@
     </releaseinfo>
   </bookinfo>
 
-  <reference>
-    <title>API Reference</title>
+  <reference label="I">
+    <title>Finch API Reference</title>
 
       <xi:include href="xml/finch.xml" />
       <xi:include href="xml/getopt.xml" />
       <xi:include href="xml/gntaccount.xml" />
+      <xi:include href="xml/gntblist.xml" />
+      <xi:include href="xml/gntcertmgr.xml" />
+      <xi:include href="xml/gntconn.xml" />
+      <xi:include href="xml/gntconv.xml" />
+      <xi:include href="xml/gntdebug.xml" />
+      <xi:include href="xml/gntidle.xml" />
+      <xi:include href="xml/gntlog.xml" />
+      <xi:include href="xml/gntmedia.xml" />
+      <xi:include href="xml/gntmenuutil.xml" />
+      <xi:include href="xml/gntnotify.xml" />
+      <xi:include href="xml/gntplugin.xml" />
+      <xi:include href="xml/gntpounce.xml" />
+      <xi:include href="xml/gntprefs.xml" />
+      <xi:include href="xml/gntrequest.xml" />
+      <xi:include href="xml/gntroomlist.xml" />
+      <xi:include href="xml/gntsound.xml" />
+      <xi:include href="xml/gntstatus.xml" />
+      <xi:include href="xml/gntui.xml" />
+      <xi:include href="xml/gntxfer.xml" />
+  </reference>
+
+  <reference label="II">
+    <title>GNT API Reference</title>
+
       <xi:include href="xml/gntbindable.xml" />
-      <xi:include href="xml/gntblist.xml" />
       <xi:include href="xml/gntbox.xml" />
       <xi:include href="xml/gntbutton.xml" />
-      <xi:include href="xml/gntcertmgr.xml" />
       <xi:include href="xml/gntcheckbox.xml" />
       <xi:include href="xml/gntclipboard.xml" />
       <xi:include href="xml/gntcolors.xml" />
       <xi:include href="xml/gntcombobox.xml" />
-      <xi:include href="xml/gntconn.xml" />
-      <xi:include href="xml/gntconv.xml" />
-      <xi:include href="xml/gntdebug.xml" />
       <xi:include href="xml/gntentry.xml" />
       <xi:include href="xml/gntfilesel.xml" />
-      <xi:include href="xml/gntidle.xml" />
       <xi:include href="xml/gntkeys.xml" />
       <xi:include href="xml/gntlabel.xml" />
       <xi:include href="xml/gntline.xml" />
-      <xi:include href="xml/gntlog.xml" />
       <xi:include href="xml/gntmarshal.xml" />
-      <xi:include href="xml/gntmedia.xml" />
       <xi:include href="xml/gntmenuitemcheck.xml" />
       <xi:include href="xml/gntmenuitem.xml" />
-      <xi:include href="xml/gntmenuutil.xml" />
       <xi:include href="xml/gntmenu.xml" />
-      <xi:include href="xml/gntnotify.xml" />
-      <xi:include href="xml/gntplugin.xml" />
-      <xi:include href="xml/gntpounce.xml" />
-      <xi:include href="xml/gntprefs.xml" />
       <xi:include href="xml/gntprogressbar.xml" />
-      <xi:include href="xml/gntrequest.xml" />
-      <xi:include href="xml/gntroomlist.xml" />
       <xi:include href="xml/gnt-skel.xml" />
       <xi:include href="xml/gntslider.xml" />
-      <xi:include href="xml/gntsound.xml" />
-      <xi:include href="xml/gntstatus.xml" />
       <xi:include href="xml/gntstyle.xml" />
       <xi:include href="xml/gnttextview.xml" />
       <xi:include href="xml/gnttree.xml" />
-      <xi:include href="xml/gntui.xml" />
       <xi:include href="xml/gntutils.xml" />
       <xi:include href="xml/gntwidget.xml" />
       <xi:include href="xml/gntwindow.xml" />
       <xi:include href="xml/gntwm.xml" />
       <xi:include href="xml/gntws.xml" />
-      <xi:include href="xml/gntxfer.xml" />
       <xi:include href="xml/gnt.xml" />
   </reference>
 
@@ -77,4 +82,5 @@
     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
   </index>
 
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 </book>
diff --git a/doc/reference/libpurple/libpurple-docs.xml b/doc/reference/libpurple/libpurple-docs.xml
--- a/doc/reference/libpurple/libpurple-docs.xml
+++ b/doc/reference/libpurple/libpurple-docs.xml
@@ -152,4 +152,5 @@
     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
   </index>
 
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 </book>
diff --git a/doc/reference/pidgin/pidgin-docs.xml b/doc/reference/pidgin/pidgin-docs.xml
--- a/doc/reference/pidgin/pidgin-docs.xml
+++ b/doc/reference/pidgin/pidgin-docs.xml
@@ -90,4 +90,5 @@
     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
   </index>
 
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 </book>
diff --git a/finch/gntblist.h b/finch/gntblist.h
--- a/finch/gntblist.h
+++ b/finch/gntblist.h
@@ -34,6 +34,8 @@
  **********************************************************************/
 /*@{*/
 
+typedef struct _FinchBlistManager  FinchBlistManager;
+
 /**
  * FinchBlistManager:
  * @id:   An identifier for the manager.
@@ -42,7 +44,7 @@
  * Buddylist manager for finch. This decides the visility, ordering and hierarchy
  * of the buddylist nodes. This also manages the creation of tooltips.
  */
-typedef struct
+struct _FinchBlistManager
 {
 	const char *id;
 	const char *name;
@@ -54,7 +56,7 @@ typedef struct
 
 	/*< private >*/
 	gpointer reserved[4];
-} FinchBlistManager;
+};
 
 /**
  * finch_blist_get_ui_ops:
diff --git a/finch/libgnt/gntcolors.h b/finch/libgnt/gntcolors.h
--- a/finch/libgnt/gntcolors.h
+++ b/finch/libgnt/gntcolors.h
@@ -95,7 +95,7 @@ void gnt_color_pairs_parse(GKeyFile *kfi
 
 /**
  * gnt_colors_get_color:
- * @kfile: The string value
+ * @key: The string value
  *
  * Parse a string color
  *
diff --git a/finch/libgnt/gntmain.c b/finch/libgnt/gntmain.c
--- a/finch/libgnt/gntmain.c
+++ b/finch/libgnt/gntmain.c
@@ -99,7 +99,10 @@ escape_timeout(gpointer data)
 }
 
 /**
+ * detect_mouse_action:
+ *
  * Mouse support:
+ *
  *  - bring a window on top if you click on its taskbar
  *  - click on the top-bar of the active window and drag+drop to move a window
  *  - click on a window to bring it to focus
diff --git a/finch/libgnt/gntutils.h b/finch/libgnt/gntutils.h
--- a/finch/libgnt/gntutils.h
+++ b/finch/libgnt/gntutils.h
@@ -125,10 +125,10 @@ GntWidget * gnt_widget_bindings_view(Gnt
  * <programlisting>
  * GntWidget *win, *button;
  * gnt_util_parse_widgets("\
- *      <vwindow id='0' fill='0' align='2'>     \
- *          <label>This is a test</label>       \
- *          <button id='1'>OK</button>          \
- *      </vwindow>",
+ *      <vwindow id='0' fill='0' align='2'>     \
+ *          <label>This is a test</label>       \
+ *          <button id='1'>OK</button>          \
+ *      </vwindow>",
  *   2, &win, &button);
  * </programlisting>
  */
diff --git a/finch/libgnt/gntwidget.c b/finch/libgnt/gntwidget.c
--- a/finch/libgnt/gntwidget.c
+++ b/finch/libgnt/gntwidget.c
@@ -302,13 +302,6 @@ void gnt_widget_set_take_focus(GntWidget
 		GNT_WIDGET_UNSET_FLAGS(widget, GNT_WIDGET_CAN_TAKE_FOCUS);
 }
 
-/**
- * gnt_widget_destroy:
- * @obj: The #GntWidget instance.
- *
- * Emits the "destroy" signal notifying all reference holders that they
- * should release @obj.
- */
 void
 gnt_widget_destroy(GntWidget *obj)
 {
diff --git a/finch/libgnt/gntwidget.h b/finch/libgnt/gntwidget.h
--- a/finch/libgnt/gntwidget.h
+++ b/finch/libgnt/gntwidget.h
@@ -151,6 +151,9 @@ GType gnt_widget_get_gtype(void);
  * @widget: The widget to destroy.
  *
  * Destroy a widget.
+ *
+ * Emits the "destroy" signal notifying all reference holders that they
+ * should release @widget.
  */
 void gnt_widget_destroy(GntWidget *widget);
 
diff --git a/finch/libgnt/gntwm.h b/finch/libgnt/gntwm.h
--- a/finch/libgnt/gntwm.h
+++ b/finch/libgnt/gntwm.h
@@ -49,7 +49,9 @@ typedef enum
 	GNT_KP_MODE_WAIT_ON_CHILD
 } GntKeyPressMode;
 
-typedef struct _GntNode
+typedef struct _GntNode GntNode;
+
+struct _GntNode
 {
 	GntWidget *me;
 
@@ -57,7 +59,7 @@ typedef struct _GntNode
 	int scroll;
 	PANEL *panel;
 	GntWS *ws;
-} GntNode;
+};
 
 typedef struct _GntWM GntWM;
 
@@ -122,6 +124,7 @@ struct _GntWM
 
 	GHashTable *positions;
 
+	/*< private >*/
 	void *res1;
 	void *res2;
 	void *res3;



More information about the Commits mailing list