Mercurial > pidgin3 / file diff

--- a/libpurple/debug.h	Wed Jan 29 00:28:08 2014 +0530
+++ b/libpurple/debug.h	Wed Jan 29 05:28:33 2014 +0530
@@ -68,9 +68,9 @@
 /**
  * Outputs debug information.
  *
- * @param level    The debug level.
- * @param category The category (or @c NULL).
- * @param format   The format string.
+ * @level:    The debug level.
+ * @category: The category (or @c NULL).
+ * @format:   The format string.
  */
 void purple_debug(PurpleDebugLevel level, const char *category,
 				const char *format, ...) G_GNUC_PRINTF(3, 4);
@@ -81,8 +81,8 @@
  * This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_MISC as
  * the level.
  *
- * @param category The category (or @c NULL).
- * @param format   The format string.
+ * @category: The category (or @c NULL).
+ * @format:   The format string.
  *
  * @see purple_debug()
  */
@@ -94,8 +94,8 @@
  * This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_INFO as
  * the level.
  *
- * @param category The category (or @c NULL).
- * @param format   The format string.
+ * @category: The category (or @c NULL).
+ * @format:   The format string.
  *
  * @see purple_debug()
  */
@@ -107,8 +107,8 @@
  * This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_WARNING as
  * the level.
  *
- * @param category The category (or @c NULL).
- * @param format   The format string.
+ * @category: The category (or @c NULL).
+ * @format:   The format string.
  *
  * @see purple_debug()
  */
@@ -120,8 +120,8 @@
  * This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_ERROR as
  * the level.
  *
- * @param category The category (or @c NULL).
- * @param format   The format string.
+ * @category: The category (or @c NULL).
+ * @format:   The format string.
  *
  * @see purple_debug()
  */
@@ -133,8 +133,8 @@
  * This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_ERROR as
  * the level.
  *
- * @param category The category (or @c NULL).
- * @param format   The format string.
+ * @category: The category (or @c NULL).
+ * @format:   The format string.
  *
  * @see purple_debug()
  */
@@ -143,14 +143,14 @@
 /**
  * Enable or disable printing debug output to the console.
  *
- * @param enabled TRUE to enable debug output or FALSE to disable it.
+ * @enabled: TRUE to enable debug output or FALSE to disable it.
  */
 void purple_debug_set_enabled(gboolean enabled);
 
 /**
  * Check if console debug output is enabled.
  *
- * @return TRUE if debugging is enabled, FALSE if it is not.
+ * Returns: TRUE if debugging is enabled, FALSE if it is not.
  */
 gboolean purple_debug_is_enabled(void);
 
@@ -159,14 +159,14 @@
  * by #purple_debug_init, but there are cases where this can be useful for
  * plugins.
  *
- * @param verbose TRUE to enable verbose debugging or FALSE to disable it.
+ * @verbose: TRUE to enable verbose debugging or FALSE to disable it.
  */
 void purple_debug_set_verbose(gboolean verbose);
 
 /**
  * Check if verbose logging is enabled.
  *
- * @return TRUE if verbose debugging is enabled, FALSE if it is not.
+ * Returns: TRUE if verbose debugging is enabled, FALSE if it is not.
  */
 gboolean purple_debug_is_verbose(void);
 
@@ -175,7 +175,7 @@
  * by #purple_debug_init, but there are cases where this can be useful for
  * plugins.
  *
- * @param unsafe TRUE to enable debug logging of messages that could
+ * @unsafe: TRUE to enable debug logging of messages that could
  *        potentially contain passwords and other sensitive information.
  *        FALSE to disable it.
  */
@@ -184,7 +184,7 @@
 /**
  * Check if unsafe debugging is enabled.  Defaults to FALSE.
  *
- * @return TRUE if the debug logging of all messages is enabled, FALSE
+ * Returns: TRUE if the debug logging of all messages is enabled, FALSE
  *         if messages that could potentially contain passwords and other
  *         sensitive information are not logged.
  */
@@ -193,7 +193,7 @@
 /**
  * Enable or disable colored output for bash console.
  *
- * @param colored TRUE to enable colored output, FALSE to disable it.
+ * @colored: TRUE to enable colored output, FALSE to disable it.
  */
 void purple_debug_set_colored(gboolean colored);
 
@@ -208,7 +208,7 @@
  * Sets the UI operations structure to be used when outputting debug
  * information.
  *
- * @param ops The UI operations structure.
+ * @ops: The UI operations structure.
  */
 void purple_debug_set_ui_ops(PurpleDebugUiOps *ops);
 
@@ -216,7 +216,7 @@
  * Returns the UI operations structure used when outputting debug
  * information.
  *
- * @return The UI operations structure in use.
+ * Returns: The UI operations structure in use.
  */
 PurpleDebugUiOps *purple_debug_get_ui_ops(void);