libpurple/core.h

branch
soc.2013.gobjectification.plugins
changeset 37023
d9bcdc9a91e6
parent 37021
04c99b24db84
child 37034
9d6765962b22
--- a/libpurple/core.h	Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/core.h	Wed Jan 29 10:49:02 2014 +0530
@@ -87,10 +87,10 @@
  *
  * This will setup preferences for all the core subsystems.
  *
- * @ui: The ID of the UI using the core. This should be a
+ * @param ui The ID of the UI using the core. This should be a
  *           unique ID, registered with the purple team.
  *
- * Returns: %TRUE if successful, or %FALSE otherwise.
+ * @return @c TRUE if successful, or @c FALSE otherwise.
  */
 gboolean purple_core_init(const char *ui);
 
@@ -124,7 +124,7 @@
 /**
  * Returns the version of the core library.
  *
- * Returns: The version of the core library.
+ * @return The version of the core library.
  */
 const char *purple_core_get_version(void);
 
@@ -132,7 +132,7 @@
  * Returns the ID of the UI that is using the core, as passed to
  * purple_core_init().
  *
- * Returns: The ID of the UI that is currently using the core.
+ * @return The ID of the UI that is currently using the core.
  */
 const char *purple_core_get_ui(void);
 
@@ -146,14 +146,14 @@
 /**
  * Sets the UI ops for the core.
  *
- * @ops: A UI ops structure for the core.
+ * @param ops A UI ops structure for the core.
  */
 void purple_core_set_ui_ops(PurpleCoreUiOps *ops);
 
 /**
  * Returns the UI ops for the core.
  *
- * Returns: The core's UI ops structure.
+ * @return The core's UI ops structure.
  */
 PurpleCoreUiOps *purple_core_get_ui_ops(void);
 
@@ -163,8 +163,8 @@
  * so whether that process is using the same configuration directory as this
  * process.
  *
- * Returns: %TRUE if this is the first instance of libpurple running;
- *         %FALSE if there is another instance running.
+ * @return @c TRUE if this is the first instance of libpurple running;
+ *         @c FALSE if there is another instance running.
  */
 gboolean purple_core_ensure_single_instance(void);
 
@@ -193,7 +193,7 @@
  *
  * </dl>
  *
- * Returns: A GHashTable with strings for keys and values.  This
+ * @return A GHashTable with strings for keys and values.  This
  * hash table must not be freed and should not be modified.
  *
  */

mercurial