/soc/2013/ankitkv/gobjectification: a453e49dc579: Fix some gtk-d...

[Ankit Vani]

Changeset: a453e49dc5799bff5a296d5c716eb79cab384f2b
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-02 23:11 +0530
Branch:	 gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/a453e49dc579

Description:

Fix some gtk-doc warnings in finch

diffstat:

 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 +++++--
 7 files changed, 20 insertions(+), 16 deletions(-)

diffs (135 lines):

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;