/soc/2013/ankitkv/gobjectification: ba28be1a7611: Convert docs f...
Ankit Vani
a at nevitus.org
Sun Feb 2 05:55:07 EST 2014
Changeset: ba28be1a7611662417e1127687711d353282eb79
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-02 16:24 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/ba28be1a7611
Description:
Convert docs from doxygen to gtk-doc format for gtkaccount to gtkconvwin
diffstat:
pidgin/gtkaccount.h | 17 ++-
pidgin/gtkblist-theme-loader.h | 14 +-
pidgin/gtkblist-theme.h | 213 ++++++++++++++++++++++++----------------
pidgin/gtkblist.h | 216 ++++++++++++++++++++++++++++------------
pidgin/gtkcertmgr.h | 6 +
pidgin/gtkconn.h | 8 +
pidgin/gtkconv-theme-loader.h | 14 +-
pidgin/gtkconv-theme.h | 78 ++++++++------
pidgin/gtkconv.h | 101 ++++++++++++-------
pidgin/gtkconvwin.h | 14 +-
10 files changed, 442 insertions(+), 239 deletions(-)
diffs (truncated from 1632 to 300 lines):
diff --git a/pidgin/gtkaccount.h b/pidgin/gtkaccount.h
--- a/pidgin/gtkaccount.h
+++ b/pidgin/gtkaccount.h
@@ -40,25 +40,32 @@ typedef enum
G_BEGIN_DECLS
/**
+ * pidgin_accounts_window_show:
+ *
* Shows the accounts window.
*/
void pidgin_accounts_window_show(void);
/**
+ * pidgin_accounts_window_hide:
+ *
* Hides the accounts window.
*/
void pidgin_accounts_window_hide(void);
/**
- * Shows an add/modify account dialog.
- *
+ * pidgin_account_dialog_show:
* @type: The type of dialog.
* @account: The associated account, or %NULL for an Add dialog.
+ *
+ * Shows an add/modify account dialog.
*/
void pidgin_account_dialog_show(PidginAccountDialogType type,
PurpleAccount *account);
/**
+ * pidgin_accounts_get_ui_ops:
+ *
* Returns the GTK+ account UI ops
*
* Returns: The UI operations structure.
@@ -66,6 +73,8 @@ void pidgin_account_dialog_show(PidginAc
PurpleAccountUiOps *pidgin_accounts_get_ui_ops(void);
/**
+ * pidgin_accounts_get_handle:
+ *
* Returns the gtkaccounts handle
*
* Returns: The handle to the GTK+ account system
@@ -73,11 +82,15 @@ PurpleAccountUiOps *pidgin_accounts_get_
void *pidgin_accounts_get_handle(void);
/**
+ * pidgin_accounts_init:
+ *
* Initializes the GTK+ account system
*/
void pidgin_accounts_init(void);
/**
+ * pidgin_accounts_uninit:
+ *
* Uninitializes the GTK+ account system
*/
void pidgin_accounts_uninit(void);
diff --git a/pidgin/gtkblist-theme-loader.h b/pidgin/gtkblist-theme-loader.h
--- a/pidgin/gtkblist-theme-loader.h
+++ b/pidgin/gtkblist-theme-loader.h
@@ -30,12 +30,6 @@
#include <glib-object.h>
#include "theme-loader.h"
-/**
- * A pidgin buddy list theme loader. extends PurpleThemeLoader (theme-loader.h)
- * This is a class designed to build sound themes
- *
- * PidginBlistThemeLoader is a GObject.
- */
typedef struct _PidginBlistThemeLoader PidginBlistThemeLoader;
typedef struct _PidginBlistThemeLoaderClass PidginBlistThemeLoaderClass;
@@ -46,6 +40,12 @@ typedef struct _PidginBlistThemeLoaderCl
#define PIDGIN_IS_BLIST_THEME_LOADER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_BLIST_THEME_LOADER))
#define PIDGIN_BLIST_THEME_LOADER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_BLIST_THEME_LOADER, PidginBlistThemeLoaderClass))
+/**
+ * PidginBlistThemeLoader:
+ *
+ * A pidgin buddy list theme loader. extends PurpleThemeLoader (theme-loader.h)
+ * This is a class designed to build sound themes
+ */
struct _PidginBlistThemeLoader
{
PurpleThemeLoader parent;
@@ -62,6 +62,8 @@ struct _PidginBlistThemeLoaderClass
G_BEGIN_DECLS
/**
+ * pidgin_blist_theme_loader_get_type:
+ *
* GObject foo.
* @internal.
*/
diff --git a/pidgin/gtkblist-theme.h b/pidgin/gtkblist-theme.h
--- a/pidgin/gtkblist-theme.h
+++ b/pidgin/gtkblist-theme.h
@@ -32,12 +32,6 @@
#include "theme.h"
-/**
- * A pidgin buddy list theme.
- * This is an object for Purple to represent a buddy list theme.
- *
- * PidginBlistTheme is a PurpleTheme Object.
- */
typedef struct _PidginBlistTheme PidginBlistTheme;
typedef struct _PidginBlistThemeClass PidginBlistThemeClass;
@@ -48,6 +42,14 @@ typedef struct _PidginBlistThemeClass
#define PIDGIN_IS_BLIST_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_BLIST_THEME))
#define PIDGIN_BLIST_THEME_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_BLIST_THEME, PidginBlistThemeClass))
+/**
+ * PidginBlistTheme:
+ *
+ * A pidgin buddy list theme.
+ * This is an object for Purple to represent a buddy list theme.
+ *
+ * PidginBlistTheme is a PurpleTheme Object.
+ */
struct _PidginBlistTheme
{
PurpleTheme parent;
@@ -86,61 +88,68 @@ G_BEGIN_DECLS
/**************************************************************************/
/**
- * Create a new PidginThemeFont.
- *
+ * pidgin_theme_font_new:
* @face: The font face
* @color: The color of the font
*
+ * Create a new PidginThemeFont.
+ *
* Returns: A newly created PidginThemeFont
*/
PidginThemeFont * pidgin_theme_font_new(const gchar *face, GdkColor *color);
/**
+ * pidgin_theme_font_free:
+ * @font: The theme font
+ *
* Frees a font and color pair
- *
- * @font: The theme font
*/
void pidgin_theme_font_free(PidginThemeFont *font);
/**
- * Set the font-face of a PidginThemeFont.
- *
+ * pidgin_theme_font_set_font_face:
* @font: The PidginThemeFont
* @face: The font-face
+ *
+ * Set the font-face of a PidginThemeFont.
*/
void pidgin_theme_font_set_font_face(PidginThemeFont *font, const gchar *face);
/**
- * Set the color of a PidginThemeFont.
- *
+ * pidgin_theme_font_set_color:
* @font: The PidginThemeFont
* @color: The color
+ *
+ * Set the color of a PidginThemeFont.
*/
void pidgin_theme_font_set_color(PidginThemeFont *font, const GdkColor *color);
/**
+ * pidgin_theme_font_get_font_face:
+ * @font: The PidginThemeFont
+ *
* Get the font-face of a PidginThemeFont.
*
- * @font: The PidginThemeFont
- *
* Returns: The font-face, or NULL if none is set.
*/
const gchar * pidgin_theme_font_get_font_face(PidginThemeFont *font);
/**
+ * pidgin_theme_font_get_color:
+ * @font: The PidginThemeFont
+ *
* Get the color of a PidginThemeFont as a GdkColor object.
*
- * @font: The PidginThemeFont
- *
* Returns: The color, or NULL if none is set.
*/
const GdkColor * pidgin_theme_font_get_color(PidginThemeFont *font);
/**
+ * pidgin_theme_font_get_color_describe:
+ * @font: The PidginThemeFont
+ *
* Get the color of a PidginThemeFont.
*
- * @font: The PidginThemeFont
- *
* Returns: The color, or NULL if none is set.
*/
const gchar * pidgin_theme_font_get_color_describe(PidginThemeFont *font);
@@ -150,6 +159,8 @@ const gchar * pidgin_theme_font_get_colo
/**************************************************************************/
/**
+ * pidgin_blist_theme_get_type:
+ *
* GObject foo.
* @internal.
*/
@@ -158,147 +169,163 @@ GType pidgin_blist_theme_get_type(void);
/* get methods */
/**
+ * pidgin_blist_theme_get_background_color:
+ * @theme: The PidginBlist theme.
+ *
* Returns the background color of the buddy list.
*
- * @theme: The PidginBlist theme.
- *
* Returns: A gdk color.
*/
GdkColor *pidgin_blist_theme_get_background_color(PidginBlistTheme *theme);
/**
+ * pidgin_blist_theme_get_opacity:
+ * @theme: The PidginBlist theme.
+ *
* Returns the opacity of the buddy list window
* (0.0 or clear to 1.0 fully opaque).
*
- * @theme: The PidginBlist theme.
- *
* Returns: The opacity
*/
gdouble pidgin_blist_theme_get_opacity(PidginBlistTheme *theme);
/**
+ * pidgin_blist_theme_get_layout:
+ * @theme: The PidginBlist theme.
+ *
* Returns the layout to be used with the buddy list.
*
- * @theme: The PidginBlist theme.
- *
* Returns: The buddy list layout.
*/
PidginBlistLayout *pidgin_blist_theme_get_layout(PidginBlistTheme *theme);
/**
+ * pidgin_blist_theme_get_expanded_background_color:
+ * @theme: The PidginBlist theme.
+ *
* Returns the background color to be used with expanded groups.
*
- * @theme: The PidginBlist theme.
- *
* Returns: A gdk color.
*/
GdkColor *pidgin_blist_theme_get_expanded_background_color(PidginBlistTheme *theme);
/**
+ * pidgin_blist_theme_get_expanded_text_info:
+ * @theme: The PidginBlist theme.
+ *
* Returns the text font and color to be used with expanded groups.
*
- * @theme: The PidginBlist theme.
- *
* Returns: A font and color pair.
*/
PidginThemeFont *pidgin_blist_theme_get_expanded_text_info(PidginBlistTheme *theme);
/**
+ * pidgin_blist_theme_get_collapsed_background_color:
+ * @theme: The PidginBlist theme.
+ *
* Returns the background color to be used with collapsed groups.
*
- * @theme: The PidginBlist theme.
- *
* Returns: A gdk color.
*/
GdkColor *pidgin_blist_theme_get_collapsed_background_color(PidginBlistTheme *theme);
More information about the Commits
mailing list