/soc/2013/ankitkv/gobjectification: dfffd1e43bfd: Convert doxyge...
Ankit Vani
a at nevitus.org
Thu Jan 30 12:32:46 EST 2014
Changeset: dfffd1e43bfd0fcaeb379a1c87fe44d4373b0048
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-30 23:02 +0530
Branch: soc.2013.gobjectification.gtkdoc
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/dfffd1e43bfd
Description:
Convert doxygen comments to gtk-doc format for debug.h to mediamanager.h
diffstat:
libpurple/debug.h | 101 ++++++++----
libpurple/desktopitem.h | 25 +-
libpurple/dnsquery.h | 49 ++++-
libpurple/dnssrv.h | 52 ++++--
libpurple/e2ee.h | 83 ++++++----
libpurple/eventloop.h | 117 ++++++++------
libpurple/http.h | 368 ++++++++++++++++++++++++++++++++--------------
libpurple/idle.h | 17 +-
libpurple/imgstore.h | 103 ++++++++-----
libpurple/internal.h | 66 ++++---
libpurple/keyring.h | 215 ++++++++++++++++++---------
libpurple/log.h | 279 +++++++++++++++++++++-------------
libpurple/media-gst.h | 101 ++++++++----
libpurple/media.h | 174 +++++++++++++--------
libpurple/mediamanager.h | 88 +++++++----
15 files changed, 1178 insertions(+), 660 deletions(-)
diffs (truncated from 4639 to 300 lines):
diff --git a/libpurple/debug.h b/libpurple/debug.h
--- a/libpurple/debug.h
+++ b/libpurple/debug.h
@@ -30,20 +30,30 @@
#include <stdarg.h>
/**
+ * PurpleDebugLevel:
+ * @PURPLE_DEBUG_ALL: All debug levels.
+ * @PURPLE_DEBUG_MISC: General chatter.
+ * @PURPLE_DEBUG_INFO: General operation Information.
+ * @PURPLE_DEBUG_WARNING: Warnings.
+ * @PURPLE_DEBUG_ERROR: Errors.
+ * @PURPLE_DEBUG_FATAL: Fatal errors.
+ *
* Debug levels.
*/
typedef enum
{
- PURPLE_DEBUG_ALL = 0, /**< All debug levels. */
- PURPLE_DEBUG_MISC, /**< General chatter. */
- PURPLE_DEBUG_INFO, /**< General operation Information. */
- PURPLE_DEBUG_WARNING, /**< Warnings. */
- PURPLE_DEBUG_ERROR, /**< Errors. */
- PURPLE_DEBUG_FATAL /**< Fatal errors. */
+ PURPLE_DEBUG_ALL = 0,
+ PURPLE_DEBUG_MISC,
+ PURPLE_DEBUG_INFO,
+ PURPLE_DEBUG_WARNING,
+ PURPLE_DEBUG_ERROR,
+ PURPLE_DEBUG_FATAL
} PurpleDebugLevel;
/**
+ * PurpleDebugUiOps:
+ *
* Debug UI operations.
*/
typedef struct
@@ -66,88 +76,97 @@ G_BEGIN_DECLS
/** @name Debug API */
/**************************************************************************/
/**
- * Outputs debug information.
- *
+ * purple_debug:
* @level: The debug level.
* @category: The category (or %NULL).
* @format: The format string.
+ *
+ * Outputs debug information.
*/
void purple_debug(PurpleDebugLevel level, const char *category,
const char *format, ...) G_GNUC_PRINTF(3, 4);
/**
+ * purple_debug_misc:
+ * @category: The category (or %NULL).
+ * @format: The format string.
+ *
* Outputs misc. level debug information.
*
* This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_MISC as
* the level.
*
- * @category: The category (or %NULL).
- * @format: The format string.
- *
* @see purple_debug()
*/
void purple_debug_misc(const char *category, const char *format, ...) G_GNUC_PRINTF(2, 3);
/**
+ * purple_debug_info:
+ * @category: The category (or %NULL).
+ * @format: The format string.
+ *
* Outputs info level debug information.
*
* This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_INFO as
* the level.
*
- * @category: The category (or %NULL).
- * @format: The format string.
- *
* @see purple_debug()
*/
void purple_debug_info(const char *category, const char *format, ...) G_GNUC_PRINTF(2, 3);
/**
+ * purple_debug_warning:
+ * @category: The category (or %NULL).
+ * @format: The format string.
+ *
* Outputs warning level debug information.
*
* This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_WARNING as
* the level.
*
- * @category: The category (or %NULL).
- * @format: The format string.
- *
* @see purple_debug()
*/
void purple_debug_warning(const char *category, const char *format, ...) G_GNUC_PRINTF(2, 3);
/**
+ * purple_debug_error:
+ * @category: The category (or %NULL).
+ * @format: The format string.
+ *
* Outputs error level debug information.
*
* This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_ERROR as
* the level.
*
- * @category: The category (or %NULL).
- * @format: The format string.
- *
* @see purple_debug()
*/
void purple_debug_error(const char *category, const char *format, ...) G_GNUC_PRINTF(2, 3);
/**
+ * purple_debug_fatal:
+ * @category: The category (or %NULL).
+ * @format: The format string.
+ *
* Outputs fatal error level debug information.
*
* This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_ERROR as
* the level.
*
- * @category: The category (or %NULL).
- * @format: The format string.
- *
* @see purple_debug()
*/
void purple_debug_fatal(const char *category, const char *format, ...) G_GNUC_PRINTF(2, 3);
/**
+ * purple_debug_set_enabled:
+ * @enabled: TRUE to enable debug output or FALSE to disable it.
+ *
* Enable or disable printing debug output to the console.
- *
- * @enabled: TRUE to enable debug output or FALSE to disable it.
*/
void purple_debug_set_enabled(gboolean enabled);
/**
+ * purple_debug_is_enabled:
+ *
* Check if console debug output is enabled.
*
* Returns: TRUE if debugging is enabled, FALSE if it is not.
@@ -155,15 +174,18 @@ void purple_debug_set_enabled(gboolean e
gboolean purple_debug_is_enabled(void);
/**
+ * purple_debug_set_verbose:
+ * @verbose: TRUE to enable verbose debugging or FALSE to disable it.
+ *
* Enable or disable verbose debugging. This ordinarily should only be called
* by #purple_debug_init, but there are cases where this can be useful for
* plugins.
- *
- * @verbose: TRUE to enable verbose debugging or FALSE to disable it.
*/
void purple_debug_set_verbose(gboolean verbose);
/**
+ * purple_debug_is_verbose:
+ *
* Check if verbose logging is enabled.
*
* Returns: TRUE if verbose debugging is enabled, FALSE if it is not.
@@ -171,17 +193,20 @@ void purple_debug_set_verbose(gboolean v
gboolean purple_debug_is_verbose(void);
/**
+ * purple_debug_set_unsafe:
+ * @unsafe: TRUE to enable debug logging of messages that could
+ * potentially contain passwords and other sensitive information.
+ * FALSE to disable it.
+ *
* Enable or disable unsafe debugging. This ordinarily should only be called
* by #purple_debug_init, but there are cases where this can be useful for
* plugins.
- *
- * @unsafe: TRUE to enable debug logging of messages that could
- * potentially contain passwords and other sensitive information.
- * FALSE to disable it.
*/
void purple_debug_set_unsafe(gboolean unsafe);
/**
+ * purple_debug_is_unsafe:
+ *
* Check if unsafe debugging is enabled. Defaults to FALSE.
*
* Returns: TRUE if the debug logging of all messages is enabled, FALSE
@@ -191,9 +216,10 @@ void purple_debug_set_unsafe(gboolean un
gboolean purple_debug_is_unsafe(void);
/**
+ * purple_debug_set_colored:
+ * @colored: TRUE to enable colored output, FALSE to disable it.
+ *
* Enable or disable colored output for bash console.
- *
- * @colored: TRUE to enable colored output, FALSE to disable it.
*/
void purple_debug_set_colored(gboolean colored);
@@ -205,14 +231,17 @@ void purple_debug_set_colored(gboolean c
/*@{*/
/**
+ * purple_debug_set_ui_ops:
+ * @ops: The UI operations structure.
+ *
* Sets the UI operations structure to be used when outputting debug
* information.
- *
- * @ops: The UI operations structure.
*/
void purple_debug_set_ui_ops(PurpleDebugUiOps *ops);
/**
+ * purple_debug_get_ui_ops:
+ *
* Returns the UI operations structure used when outputting debug
* information.
*
@@ -228,6 +257,8 @@ PurpleDebugUiOps *purple_debug_get_ui_op
/*@{*/
/**
+ * purple_debug_init:
+ *
* Initializes the debug subsystem.
*/
void purple_debug_init(void);
diff --git a/libpurple/desktopitem.h b/libpurple/desktopitem.h
--- a/libpurple/desktopitem.h
+++ b/libpurple/desktopitem.h
@@ -116,54 +116,59 @@ GType purple_desktop_item_get_type
#define PURPLE_DESKTOP_ITEM_DOC_PATH "X-GNOME-DocPath" /* string */
/**
+ * purple_desktop_item_new_from_file:
+ * @filename: The filename or directory path to load the PurpleDesktopItem from
+ *
* This function loads 'filename' and turns it into a PurpleDesktopItem.
*
- * @filename: The filename or directory path to load the PurpleDesktopItem from
- *
* Returns: The newly loaded item, or NULL on error.
*/
PurpleDesktopItem *purple_desktop_item_new_from_file (const char *filename);
/**
+ * purple_desktop_item_get_entry_type:
+ * @item: A desktop item
+ *
* Gets the type attribute (the 'Type' field) of the item. This should
* usually be 'Application' for an application, but it can be 'Directory'
* for a directory description. There are other types available as well.
* The type usually indicates how the desktop item should be handeled and
* how the 'Exec' field should be handeled.
*
- * @item: A desktop item
- *
* Returns: The type of the specified 'item'. The returned memory
* remains owned by the PurpleDesktopItem and should not be freed.
*/
PurpleDesktopItemType purple_desktop_item_get_entry_type (const PurpleDesktopItem *item);
/**
- * Gets the value of an attribute of the item, as a string.
- *
+ * purple_desktop_item_get_string:
* @item: A desktop item
* @attr: The attribute to look for
*
+ * Gets the value of an attribute of the item, as a string.
+ *
* Returns: The value of the specified item attribute.
*/
const char *purple_desktop_item_get_string (const PurpleDesktopItem *item,
const char *attr);
/**
+ * purple_desktop_item_copy:
+ * @item: The item to be copied
+ *
* Creates a copy of a PurpleDesktopItem. The new copy has a refcount of 1.
* Note: Section stack is NOT copied.
More information about the Commits
mailing list