libpurple/accounts.h

branch
gtkdoc-conversion
changeset 35393
00f876b129bc
parent 35024
eb3afb7643ce
child 35394
38facb8226d4
child 37035
e85ed7f4d6e3
--- a/libpurple/accounts.h	Fri Jan 31 17:56:27 2014 +0530
+++ b/libpurple/accounts.h	Fri Jan 31 18:14:33 2014 +0530
@@ -62,7 +62,7 @@
 	 * list.  To authorize them to see this account's presence, call \a
 	 * authorize_cb (\a message, \a user_data); otherwise call
 	 * \a deny_cb (\a message, \a user_data);
-	 * @return a UI-specific handle, as passed to #close_account_request.
+	 * Returns: a UI-specific handle, as passed to #close_account_request.
 	 */
 	void *(*request_authorize)(PurpleAccount *account,
 	                           const char *remote_user,
@@ -101,14 +101,14 @@
 /**
  * Adds an account to the list of accounts.
  *
- * @param account The account.
+ * @account: The account.
  */
 void purple_accounts_add(PurpleAccount *account);
 
 /**
  * Removes an account from the list of accounts.
  *
- * @param account The account.
+ * @account: The account.
  */
 void purple_accounts_remove(PurpleAccount *account);
 
@@ -119,29 +119,29 @@
  * account, buddy pounces that belong to this account, and will also
  * destroy @a account.
  *
- * @param account The account.
+ * @account: The account.
  */
 void purple_accounts_delete(PurpleAccount *account);
 
 /**
  * Reorders an account.
  *
- * @param account   The account to reorder.
- * @param new_index The new index for the account.
+ * @account:   The account to reorder.
+ * @new_index: The new index for the account.
  */
 void purple_accounts_reorder(PurpleAccount *account, guint new_index);
 
 /**
  * Returns a list of all accounts.
  *
- * @constreturn A list of all accounts.
+ * Returns: (TODO const): A list of all accounts.
  */
 GList *purple_accounts_get_all(void);
 
 /**
  * Returns a list of all enabled accounts
  *
- * @return A list of all enabled accounts. The list is owned
+ * Returns: A list of all enabled accounts. The list is owned
  *         by the caller, and must be g_list_free()d to avoid
  *         leaking the nodes.
  */
@@ -150,10 +150,10 @@
 /**
  * Finds an account with the specified name and protocol id.
  *
- * @param name     The account username.
- * @param protocol The account protocol ID.
+ * @name:     The account username.
+ * @protocol: The account protocol ID.
  *
- * @return The account, if found, or @c FALSE otherwise.
+ * Returns: The account, if found, or %FALSE otherwise.
  */
 PurpleAccount *purple_accounts_find(const char *name, const char *protocol);
 
@@ -178,14 +178,14 @@
 /**
  * Sets the UI operations structure to be used for accounts.
  *
- * @param ops The UI operations structure.
+ * @ops: The UI operations structure.
  */
 void purple_accounts_set_ui_ops(PurpleAccountUiOps *ops);
 
 /**
  * Returns the UI operations structure used for accounts.
  *
- * @return The UI operations structure in use.
+ * Returns: The UI operations structure in use.
  */
 PurpleAccountUiOps *purple_accounts_get_ui_ops(void);
 
@@ -200,7 +200,7 @@
 /**
  * Returns the accounts subsystem handle.
  *
- * @return The accounts subsystem handle.
+ * Returns: The accounts subsystem handle.
  */
 void *purple_accounts_get_handle(void);
 

mercurial