/soc/2013/ankitkv/gobjectification: 35c615531b2a: Convert docs f...
Ankit Vani
a at nevitus.org
Sun Feb 2 07:06:03 EST 2014
Changeset: 35c615531b2ae1b182138caaef2784b66dedf4b0
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-02 16:55 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/35c615531b2a
Description:
Convert docs from doxygen to gtk-doc format for gtkdebug to gtksmiley
diffstat:
pidgin/gtkdebug.h | 12 ++++++++++
pidgin/gtkdnd-hints.h | 48 +++++++++++++++++++++++++++++-------------
pidgin/gtkdocklet.h | 2 +
pidgin/gtkeventloop.h | 2 +
pidgin/gtkicon-theme-loader.h | 15 ++++++++-----
pidgin/gtkicon-theme.h | 29 ++++++++++++++++---------
pidgin/gtkidle.h | 2 +
pidgin/gtklog.h | 37 ++++++++++++++++++++++++--------
pidgin/gtkmenutray.h | 38 ++++++++++++++++++++++-----------
pidgin/gtknotify.h | 19 +++++++++++++---
pidgin/gtkpluginpref.h | 4 ++-
pidgin/gtkpounce.h | 13 +++++++++-
pidgin/gtkprefs.h | 39 +++++++++++++++++++++++-----------
pidgin/gtkprivacy.h | 24 ++++++++++++++-------
pidgin/gtkrequest.h | 13 +++++++++-
pidgin/gtkroomlist.h | 11 ++++++++-
pidgin/gtksavedstatuses.h | 43 +++++++++++++++++++++++++-------------
pidgin/gtksession.h | 9 +++++--
pidgin/gtksmiley.h | 41 +++++++++++++++++++++++++-----------
19 files changed, 283 insertions(+), 118 deletions(-)
diffs (truncated from 1098 to 300 lines):
diff --git a/pidgin/gtkdebug.h b/pidgin/gtkdebug.h
--- a/pidgin/gtkdebug.h
+++ b/pidgin/gtkdebug.h
@@ -31,16 +31,22 @@
G_BEGIN_DECLS
/**
+ * pidgin_debug_init:
+ *
* Initializes the GTK+ debug system.
*/
void pidgin_debug_init(void);
/**
+ * pidgin_debug_uninit:
+ *
* Uninitialized the GTK+ debug system.
*/
void pidgin_debug_uninit(void);
/**
+ * pidgin_debug_get_handle:
+ *
* Get the handle for the GTK+ debug system.
*
* Returns: the handle to the debug system
@@ -48,16 +54,22 @@ void pidgin_debug_uninit(void);
void *pidgin_debug_get_handle(void);
/**
+ * pidgin_debug_window_show:
+ *
* Shows the debug window.
*/
void pidgin_debug_window_show(void);
/**
+ * pidgin_debug_window_hide:
+ *
* Hides the debug window.
*/
void pidgin_debug_window_hide(void);
/**
+ * pidgin_debug_get_ui_ops:
+ *
* Returns the UI operations structure for GTK+ debug output.
*
* Returns: The GTK+ UI debug operations structure.
diff --git a/pidgin/gtkdnd-hints.h b/pidgin/gtkdnd-hints.h
--- a/pidgin/gtkdnd-hints.h
+++ b/pidgin/gtkdnd-hints.h
@@ -28,60 +28,78 @@
#include <gtk/gtk.h>
/**
+ * DndHintWindowId:
+ * @HINT_ARROW_UP: Up arrow.
+ * @HINT_ARROW_DOWN: Down arrow.
+ * @HINT_ARROW_LEFT: Left arrow.
+ * @HINT_ARROW_RIGHT: Right arrow.
+ *
* Conversation drag-and-drop arrow types.
*/
typedef enum
{
- HINT_ARROW_UP, /**< Up arrow. */
- HINT_ARROW_DOWN, /**< Down arrow. */
- HINT_ARROW_LEFT, /**< Left arrow. */
- HINT_ARROW_RIGHT /**< Right arrow. */
+ HINT_ARROW_UP,
+ HINT_ARROW_DOWN,
+ HINT_ARROW_LEFT,
+ HINT_ARROW_RIGHT
} DndHintWindowId;
/**
+ * DndHintPosition:
+ * @HINT_POSITION_RIGHT: Position to the right of a tab.
+ * @HINT_POSITION_LEFT: Position to the left of a tab.
+ * @HINT_POSITION_TOP: Position above a tab.
+ * @HINT_POSITION_BOTTOM: Position below a tab.
+ * @HINT_POSITION_CENTER: Position in the center of a tab.
+ *
* Conversation drag-and-drop arrow positions.
*/
typedef enum {
- HINT_POSITION_RIGHT, /**< Position to the right of a tab. */
- HINT_POSITION_LEFT, /**< Position to the left of a tab. */
- HINT_POSITION_TOP, /**< Position above a tab. */
- HINT_POSITION_BOTTOM, /**< Position below a tab. */
- HINT_POSITION_CENTER /**< Position in the center of a tab. */
+ HINT_POSITION_RIGHT,
+ HINT_POSITION_LEFT,
+ HINT_POSITION_TOP,
+ HINT_POSITION_BOTTOM,
+ HINT_POSITION_CENTER
} DndHintPosition;
G_BEGIN_DECLS
/**
- * Shows a drag-and-drop hint at the specified location.
- *
+ * dnd_hints_show:
* @id: The ID of the hint to show.
* @x: The X location to show it at.
* @y: The Y location to show it at.
+ *
+ * Shows a drag-and-drop hint at the specified location.
*/
void dnd_hints_show(DndHintWindowId id, gint x, gint y);
/**
+ * dnd_hints_hide:
+ * @id: The ID of the hint to hide.
+ *
* Hides the specified drag-and-drop hint.
- *
- * @id: The ID of the hint to hide.
*/
void dnd_hints_hide(DndHintWindowId id);
/**
+ * dnd_hints_hide_all:
+ *
* Hides all drag-and-drop hints.
*/
void dnd_hints_hide_all(void);
/**
- * Shows a drag-and-drop hint relative to a widget.
- *
+ * dnd_hints_show_relative:
* @id: The ID of the hint.
* @widget: The widget that the hint is relative to.
* @horiz: The horizontal relative position.
* @vert: The vertical relative position.
+ *
+ * Shows a drag-and-drop hint relative to a widget.
*/
void dnd_hints_show_relative(DndHintWindowId id, GtkWidget *widget,
DndHintPosition horiz, DndHintPosition vert);
diff --git a/pidgin/gtkdocklet.h b/pidgin/gtkdocklet.h
--- a/pidgin/gtkdocklet.h
+++ b/pidgin/gtkdocklet.h
@@ -35,6 +35,8 @@ typedef enum
} PidginDockletFlag;
/**
+ * pidgin_docklet_get_status_icon:
+ *
* Returns the GtkStatusIcon used for the docklet.
*/
GtkStatusIcon *pidgin_docklet_get_status_icon(void);
diff --git a/pidgin/gtkeventloop.h b/pidgin/gtkeventloop.h
--- a/pidgin/gtkeventloop.h
+++ b/pidgin/gtkeventloop.h
@@ -31,6 +31,8 @@
G_BEGIN_DECLS
/**
+ * pidgin_eventloop_get_ui_ops:
+ *
* Returns the GTK+ event loop UI operations structure.
*
* Returns: The GTK+ event loop UI operations structure.
diff --git a/pidgin/gtkicon-theme-loader.h b/pidgin/gtkicon-theme-loader.h
--- a/pidgin/gtkicon-theme-loader.h
+++ b/pidgin/gtkicon-theme-loader.h
@@ -30,12 +30,6 @@
#include <glib-object.h>
#include "theme-loader.h"
-/**
- * A pidgin icon theme loader. Extends PurpleThemeLoader (theme-loader.h)
- * This is a class designed to build icon themes
- *
- * PidginIconThemeLoader is a GObject.
- */
typedef struct _PidginIconThemeLoader PidginIconThemeLoader;
typedef struct _PidginIconThemeLoaderClass PidginIconThemeLoaderClass;
@@ -46,6 +40,12 @@ typedef struct _PidginIconThemeLoaderCla
#define PIDGIN_IS_ICON_THEME_LOADER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_ICON_THEME_LOADER))
#define PIDGIN_ICON_THEME_LOADER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_ICON_THEME_LOADER, PidginIconThemeLoaderClass))
+/**
+ * PidginIconThemeLoader:
+ *
+ * A pidgin icon theme loader. Extends PurpleThemeLoader (theme-loader.h)
+ * This is a class designed to build icon themes
+ */
struct _PidginIconThemeLoader
{
PurpleThemeLoader parent;
@@ -62,10 +62,13 @@ struct _PidginIconThemeLoaderClass
G_BEGIN_DECLS
/**
+ * pidgin_icon_theme_loader_get_type:
+ *
* GObject foo.
* @internal.
*/
GType pidgin_icon_theme_loader_get_type(void);
G_END_DECLS
+
#endif /* PIDGIN_ICON_THEME_LOADER_H */
diff --git a/pidgin/gtkicon-theme.h b/pidgin/gtkicon-theme.h
--- a/pidgin/gtkicon-theme.h
+++ b/pidgin/gtkicon-theme.h
@@ -30,13 +30,6 @@
#include <glib-object.h>
#include "theme.h"
-/**
- * extends PurpleTheme (theme.h)
- * A pidgin icon theme.
- * This object represents a Pidgin icon theme.
- *
- * PidginIconTheme is a PurpleTheme Object.
- */
typedef struct _PidginIconTheme PidginIconTheme;
typedef struct _PidginIconThemeClass PidginIconThemeClass;
@@ -47,6 +40,15 @@ typedef struct _PidginIconThemeClass P
#define PIDGIN_IS_ICON_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_ICON_THEME))
#define PIDGIN_ICON_THEME_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_ICON_THEME, PidginIconThemeClass))
+/**
+ * PidginIconTheme:
+ *
+ * extends PurpleTheme (theme.h)
+ * A pidgin icon theme.
+ * This object represents a Pidgin icon theme.
+ *
+ * PidginIconTheme is a PurpleTheme Object.
+ */
struct _PidginIconTheme
{
PurpleTheme parent;
@@ -63,32 +65,37 @@ struct _PidginIconThemeClass
G_BEGIN_DECLS
/**
+ * pidgin_icon_theme_get_type:
+ *
* GObject foo.
* @internal.
*/
GType pidgin_icon_theme_get_type(void);
/**
- * Returns a copy of the filename for the icon event or NULL if it is not set
- *
+ * pidgin_icon_theme_get_icon:
* @theme: the theme
* @event: the pidgin icon event to look up
*
+ * Returns a copy of the filename for the icon event or NULL if it is not set
+ *
* Returns: the filename of the icon event
*/
const gchar *pidgin_icon_theme_get_icon(PidginIconTheme *theme,
const gchar *event);
/**
- * Sets the filename for a given icon id, setting the icon to NULL will remove the icon from the theme
- *
+ * pidgin_icon_theme_set_icon:
* @theme: the theme
* @icon_id: a string representing what the icon is to be used for
* @filename: the name of the file to be used for the given id
+ *
+ * Sets the filename for a given icon id, setting the icon to NULL will remove the icon from the theme
*/
void pidgin_icon_theme_set_icon(PidginIconTheme *theme,
const gchar *icon_id,
const gchar *filename);
G_END_DECLS
+
#endif /* PIDGIN_ICON_THEME_H */
diff --git a/pidgin/gtkidle.h b/pidgin/gtkidle.h
--- a/pidgin/gtkidle.h
+++ b/pidgin/gtkidle.h
@@ -36,6 +36,8 @@ G_BEGIN_DECLS
/*@{*/
/**
+ * pidgin_idle_get_ui_ops:
+ *
* Returns the GTK+ idle UI ops.
*
* Returns: The UI operations structure.
More information about the Commits
mailing list