Mercurial > pidgin3 / file diff

--- a/finch/libgnt/gntstyle.h	Wed Jan 29 10:10:12 2014 +0530
+++ b/finch/libgnt/gntstyle.h	Wed Jan 29 10:49:02 2014 +0530
@@ -40,25 +40,25 @@
 /**
  * Read configuration from a file.
  *
- * @filename:  The filename to read configuration from.
+ * @param filename  The filename to read configuration from.
  */
 void gnt_style_read_configure_file(const char *filename);
 
 /**
  * Get the user-setting for a style.
- * @style:  The style.
- * Returns:  The user-setting, or %NULL.
+ * @param style  The style.
+ * @return  The user-setting, or @c NULL.
  */
 const char *gnt_style_get(GntStyle style);
 
 /**
  * Get the value of a preference in ~/.gntrc.
  *
- * @group:   The name of the group in the keyfile. If %NULL, the prgname
+ * @param group   The name of the group in the keyfile. If @c NULL, the prgname
  *                will be used first, if available. Otherwise, "general" will be used.
- * @key:     The key
+ * @param key     The key
  *
- * Returns:  The value of the setting as a string, or %NULL
+ * @return  The value of the setting as a string, or @c NULL
  *
  * @since 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -67,12 +67,12 @@
 /**
  * Get the value of a preference in ~/.gntrc.
  *
- * @group:   The name of the group in the keyfile. If %NULL, the prgname
+ * @param group   The name of the group in the keyfile. If @c NULL, the prgname
  *                will be used first, if available. Otherwise, "general" will be used.
- * @key:     The key
- * @length:  Return location for the number of strings returned, or NULL
+ * @param key     The key
+ * @param length  Return location for the number of strings returned, or NULL
  *
- * Returns:        NULL terminated string array. The array should be freed with g_strfreev().
+ * @return        NULL terminated string array. The array should be freed with g_strfreev().
  *
  * @since 2.4.0
  */
@@ -81,11 +81,11 @@
 /**
  * Get the value of a color pair in ~/.gntrc.
  *
- * @group:   The name of the group in the keyfile. If %NULL, the prgname
+ * @param group   The name of the group in the keyfile. If @c NULL, the prgname
  *                will be used first, if available. Otherwise, "general" will be used.
- * @key:     The key
+ * @param key     The key
  *
- * Returns:  The value of the color as an int, or 0 on error.
+ * @return  The value of the color as an int, or 0 on error.
  *
  * @since 2.4.0
  */
@@ -93,10 +93,10 @@
 
 /**
  * Parse a boolean preference. For example, if 'value' is "false" (ignoring case)
- * or "0", the return value will be %FALSE, otherwise %TRUE.
+ * or "0", the return value will be @c FALSE, otherwise @c TRUE.
  *
- * @value:   The value of the boolean setting as a string
- * Returns:    The boolean value
+ * @param value   The value of the boolean setting as a string
+ * @return    The boolean value
  *
  * @since 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -105,11 +105,11 @@
 /**
  * Get the boolean value for a user-setting.
  *
- * @style:  The style.
- * @def:    The default value (i.e, the value if the user didn't define
+ * @param style  The style.
+ * @param def    The default value (i.e, the value if the user didn't define
  *               any value)
  *
- * Returns:  The value of the setting.
+ * @return  The value of the setting.
  */
 gboolean gnt_style_get_bool(GntStyle style, gboolean def);
 
@@ -126,10 +126,10 @@
 /**
  * Read menu-accels from ~/.gntrc
  *
- * @name:  The name of the window.
- * @table: The hastable to store the accel information.
+ * @param name  The name of the window.
+ * @param table The hastable to store the accel information.
  *
- * Returns:  %TRUE if some accels were read, %FALSE otherwise.
+ * @return  @c TRUE if some accels were read, @c FALSE otherwise.
  */
 gboolean gnt_style_read_menu_accels(const char *name, GHashTable *table);