Initial replacements for gtk-doc style comments

1 files changed, 61 insertions, 61 deletions

diff --git a/libpurple/prefs.h b/libpurple/prefs.h
index d64dcf1339..683e2a6cd8 100644
--- a/libpurple/prefs.h
+++ b/libpurple/prefs.h
@@ -47,14 +47,14 @@ typedef enum
 /**
  * The type of callbacks for preference changes.
  *
- * @param name the name of the preference which has changed.
- * @param type the type of the preferenced named @a name
- * @param val  the new value of the preferencs; should be cast to the correct
+ * @name: the name of the preference which has changed.
+ * @type: the type of the preferenced named @a name
+ * @val:  the new value of the preferencs; should be cast to the correct
  *             type.  For instance, to recover the value of a #PURPLE_PREF_INT
  *             preference, use <tt>GPOINTER_TO_INT(val)</tt>.  Alternatively,
  *             just call purple_prefs_get_int(), purple_prefs_get_string_list()
  *             etc.
- * @param data Arbitrary data specified when the callback was connected with
+ * @data: Arbitrary data specified when the callback was connected with
  *             purple_prefs_connect_callback().
  *
  * @see purple_prefs_connect_callback()
@@ -74,7 +74,7 @@ G_BEGIN_DECLS
 /**
  * Returns the prefs subsystem handle.
  *
- * @return The prefs subsystem handle.
+ * Returns: The prefs subsystem handle.
  */
 void *purple_prefs_get_handle(void);
 
@@ -91,40 +91,40 @@ void purple_prefs_uninit(void);
 /**
  * Add a new typeless pref.
  *
- * @param name  The name of the pref
+ * @name:  The name of the pref
  */
 void purple_prefs_add_none(const char *name);
 
 /**
  * Add a new boolean pref.
  *
- * @param name  The name of the pref
- * @param value The initial value to set
+ * @name:  The name of the pref
+ * @value: The initial value to set
  */
 void purple_prefs_add_bool(const char *name, gboolean value);
 
 /**
  * Add a new integer pref.
  *
- * @param name  The name of the pref
- * @param value The initial value to set
+ * @name:  The name of the pref
+ * @value: The initial value to set
  */
 void purple_prefs_add_int(const char *name, int value);
 
 /**
  * Add a new string pref.
  *
- * @param name  The name of the pref
- * @param value The initial value to set
+ * @name:  The name of the pref
+ * @value: The initial value to set
  */
 void purple_prefs_add_string(const char *name, const char *value);
 
 /**
  * Add a new string list pref.
  *
- * @param name  The name of the pref
- * @param value The initial value to set
- * @note This function takes a copy of the strings in the value list. The list
+ * @name:  The name of the pref
+ * @value: The initial value to set
+ * Note: This function takes a copy of the strings in the value list. The list
  *       itself and original copies of the strings are up to the caller to
  *       free.
  */
@@ -133,17 +133,17 @@ void purple_prefs_add_string_list(const char *name, GList *value);
 /**
  * Add a new path pref.
  *
- * @param name  The name of the pref
- * @param value The initial value to set
+ * @name:  The name of the pref
+ * @value: The initial value to set
  */
 void purple_prefs_add_path(const char *name, const char *value);
 
 /**
  * Add a new path list pref.
  *
- * @param name  The name of the pref
- * @param value The initial value to set
- * @note This function takes a copy of the strings in the value list. The list
+ * @name:  The name of the pref
+ * @value: The initial value to set
+ * Note: This function takes a copy of the strings in the value list. The list
  *       itself and original copies of the strings are up to the caller to
  *       free.
  */
@@ -153,23 +153,23 @@ void purple_prefs_add_path_list(const char *name, GList *value);
 /**
  * Remove a pref.
  *
- * @param name The name of the pref
+ * @name: The name of the pref
  */
 void purple_prefs_remove(const char *name);
 
 /**
  * Rename a pref
  *
- * @param oldname The old name of the pref
- * @param newname The new name for the pref
+ * @oldname: The old name of the pref
+ * @newname: The new name for the pref
  */
 void purple_prefs_rename(const char *oldname, const char *newname);
 
 /**
  * Rename a boolean pref, toggling it's value
  *
- * @param oldname The old name of the pref
- * @param newname The new name for the pref
+ * @oldname: The old name of the pref
+ * @newname: The new name for the pref
  */
 void purple_prefs_rename_boolean_toggle(const char *oldname, const char *newname);
 
@@ -181,48 +181,48 @@ void purple_prefs_destroy(void);
 /**
  * Set boolean pref value
  *
- * @param name  The name of the pref
- * @param value The value to set
+ * @name:  The name of the pref
+ * @value: The value to set
  */
 void purple_prefs_set_bool(const char *name, gboolean value);
 
 /**
  * Set integer pref value
  *
- * @param name  The name of the pref
- * @param value The value to set
+ * @name:  The name of the pref
+ * @value: The value to set
  */
 void purple_prefs_set_int(const char *name, int value);
 
 /**
  * Set string pref value
  *
- * @param name  The name of the pref
- * @param value The value to set
+ * @name:  The name of the pref
+ * @value: The value to set
  */
 void purple_prefs_set_string(const char *name, const char *value);
 
 /**
  * Set string list pref value
  *
- * @param name  The name of the pref
- * @param value The value to set
+ * @name:  The name of the pref
+ * @value: The value to set
  */
 void purple_prefs_set_string_list(const char *name, GList *value);
 
 /**
  * Set path pref value
  *
- * @param name  The name of the pref
- * @param value The value to set
+ * @name:  The name of the pref
+ * @value: The value to set
  */
 void purple_prefs_set_path(const char *name, const char *value);
 
 /**
  * Set path list pref value
  *
- * @param name  The name of the pref
- * @param value The value to set
+ * @name:  The name of the pref
+ * @value: The value to set
  */
 void purple_prefs_set_path_list(const char *name, GList *value);
 
@@ -230,73 +230,73 @@ void purple_prefs_set_path_list(const char *name, GList *value);
 /**
  * Check if a pref exists
  *
- * @param name The name of the pref
- * @return TRUE if the pref exists.  Otherwise FALSE.
+ * @name: The name of the pref
+ * Returns: TRUE if the pref exists.  Otherwise FALSE.
  */
 gboolean purple_prefs_exists(const char *name);
 
 /**
  * Get pref type
  *
- * @param name The name of the pref
- * @return The type of the pref
+ * @name: The name of the pref
+ * Returns: The type of the pref
  */
 PurplePrefType purple_prefs_get_type(const char *name);
 
 /**
  * Get boolean pref value
  *
- * @param name The name of the pref
- * @return The value of the pref
+ * @name: The name of the pref
+ * Returns: The value of the pref
  */
 gboolean purple_prefs_get_bool(const char *name);
 
 /**
  * Get integer pref value
  *
- * @param name The name of the pref
- * @return The value of the pref
+ * @name: The name of the pref
+ * Returns: The value of the pref
  */
 int purple_prefs_get_int(const char *name);
 
 /**
  * Get string pref value
  *
- * @param name The name of the pref
- * @return The value of the pref
+ * @name: The name of the pref
+ * Returns: The value of the pref
  */
 const char *purple_prefs_get_string(const char *name);
 
 /**
  * Get string list pref value
  *
- * @param name The name of the pref
- * @return The value of the pref
+ * @name: The name of the pref
+ * Returns: The value of the pref
  */
 GList *purple_prefs_get_string_list(const char *name);
 
 /**
  * Get path pref value
  *
- * @param name The name of the pref
- * @return The value of the pref
+ * @name: The name of the pref
+ * Returns: The value of the pref
  */
 const char *purple_prefs_get_path(const char *name);
 
 /**
  * Get path list pref value
  *
- * @param name The name of the pref
- * @return The value of the pref
+ * @name: The name of the pref
+ * Returns: The value of the pref
  */
 GList *purple_prefs_get_path_list(const char *name);
 
 /**
  * Returns a list of children for a pref
  *
- * @param name The parent pref
- * @return A list of newly allocated strings denoting the names of the children.
- *         Returns @c NULL if there are no children or if pref doesn't exist.
+ * @name: The parent pref
+ * Returns: A list of newly allocated strings denoting the names of the children.
+ *         Returns %NULL if there are no children or if pref doesn't exist.
  *         The caller must free all the strings and the list.
  */
 GList *purple_prefs_get_children_names(const char *name);
@@ -304,12 +304,12 @@ GList *purple_prefs_get_children_names(const char *name);
 /**
  * Add a callback to a pref (and its children)
  *
- * @param handle   The handle of the receiver.
- * @param name     The name of the preference
- * @param cb       The callback function
- * @param data     The data to pass to the callback function.
+ * @handle:   The handle of the receiver.
+ * @name:     The name of the preference
+ * @cb:       The callback function
+ * @data:     The data to pass to the callback function.
  *
- * @return An id to disconnect the callback
+ * Returns: An id to disconnect the callback
  *
  * @see purple_prefs_disconnect_callback
  */