Mercurial > pidgin3 / file diff

--- a/libpurple/e2ee.h	Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/e2ee.h	Wed Jan 29 10:49:02 2014 +0530
@@ -48,9 +48,9 @@
  *
  * State objects are global (shared between multiple conversations).
  *
- * @provider: The E2EE provider that created this state.
+ * @param provider The E2EE provider that created this state.
  *
- * Returns: New E2EE state.
+ * @return New E2EE state.
  */
 PurpleE2eeState *
 purple_e2ee_state_new(PurpleE2eeProvider *provider);
@@ -58,7 +58,7 @@
 /**
  * Increment the reference count.
  *
- * @state: The E2EE state.
+ * @param state The E2EE state.
  */
 void
 purple_e2ee_state_ref(PurpleE2eeState *state);
@@ -68,9 +68,9 @@
  *
  * If the reference count reaches zero, the state will be freed.
  *
- * @state: The E2EE state.
+ * @param state The E2EE state.
  *
- * Returns: @a state or %NULL if the reference count reached zero.
+ * @return @a state or @c NULL if the reference count reached zero.
  */
 PurpleE2eeState *
 purple_e2ee_state_unref(PurpleE2eeState *state);
@@ -78,9 +78,9 @@
 /**
  * Gets the provider of specified E2EE state.
  *
- * @state: The E2EE state.
+ * @param state The E2EE state.
  *
- * Returns: The provider for this state.
+ * @return The provider for this state.
  */
 PurpleE2eeProvider *
 purple_e2ee_state_get_provider(PurpleE2eeState *state);
@@ -88,8 +88,8 @@
 /**
  * Sets the name for the E2EE state.
  *
- * @state: The E2EE state.
- * @name:  The localized name.
+ * @param state The E2EE state.
+ * @param name  The localized name.
  */
 void
 purple_e2ee_state_set_name(PurpleE2eeState *state, const gchar *name);
@@ -97,9 +97,9 @@
 /**
  * Gets the name of the E2EE state.
  *
- * @state: The E2EE state.
+ * @param state The E2EE state.
  *
- * Returns: The localized name.
+ * @return The localized name.
  */
 const gchar *
 purple_e2ee_state_get_name(PurpleE2eeState *state);
@@ -107,8 +107,8 @@
 /**
  * Sets the icon for the E2EE state.
  *
- * @state:      The E2EE state.
- * @stock_icon: The stock icon identifier.
+ * @param state      The E2EE state.
+ * @param stock_icon The stock icon identifier.
  */
 void
 purple_e2ee_state_set_stock_icon(PurpleE2eeState *state,
@@ -117,9 +117,9 @@
 /**
  * Gets the icon of the E2EE state.
  *
- * @state: The E2EE state.
+ * @param state The E2EE state.
  *
- * Returns: The stock icon identifier.
+ * @return The stock icon identifier.
  */
 const gchar *
 purple_e2ee_state_get_stock_icon(PurpleE2eeState *state);
@@ -135,7 +135,7 @@
 /**
  * Creates new E2EE provider.
  *
- * Returns: New E2EE provider.
+ * @return New E2EE provider.
  */
 PurpleE2eeProvider *
 purple_e2ee_provider_new(void);
@@ -145,7 +145,7 @@
  *
  * The provider have to be unregistered prior.
  *
- * @provider: The provider.
+ * @param provider The provider.
  */
 void
 purple_e2ee_provider_free(PurpleE2eeProvider *provider);
@@ -156,10 +156,10 @@
  * Currently, there is no support for multiple E2EE providers - only the first
  * one is registered.
  *
- * @provider: The E2EE provider.
+ * @param provider The E2EE provider.
  *
- * Returns: %TRUE, if the provider was successfully registered,
- *         %FALSE otherwise.
+ * @return @c TRUE, if the provider was successfully registered,
+ *         @c FALSE otherwise.
  */
 gboolean
 purple_e2ee_provider_register(PurpleE2eeProvider *provider);
@@ -167,7 +167,7 @@
 /**
  * Unregisters the E2EE provider.
  *
- * @provider: The E2EE provider.
+ * @param provider The E2EE provider.
  */
 void
 purple_e2ee_provider_unregister(PurpleE2eeProvider *provider);
@@ -175,7 +175,7 @@
 /**
  * Gets main E2EE provider.
  *
- * Returns: The main E2EE provider.
+ * @return The main E2EE provider.
  */
 PurpleE2eeProvider *
 purple_e2ee_provider_get_main(void);
@@ -183,8 +183,8 @@
 /**
  * Sets the name for the E2EE provider.
  *
- * @provider: The E2EE provider.
- * @name:     The localized name.
+ * @param provider The E2EE provider.
+ * @param name     The localized name.
  */
 void
 purple_e2ee_provider_set_name(PurpleE2eeProvider *provider, const gchar *name);
@@ -192,9 +192,9 @@
 /**
  * Gets the name of the E2EE provider.
  *
- * @provider: The E2EE provider.
+ * @param provider The E2EE provider.
  *
- * Returns: The localized name of specified E2EE provider.
+ * @return The localized name of specified E2EE provider.
  */
 const gchar *
 purple_e2ee_provider_get_name(PurpleE2eeProvider *provider);
@@ -207,8 +207,8 @@
  *
  * Function should return the GList of PurpleMenuAction objects.
  *
- * @provider:     The E2EE provider.
- * @conv_menu_cb: The callback.
+ * @param provider     The E2EE provider.
+ * @param conv_menu_cb The callback.
  */
 void
 purple_e2ee_provider_set_conv_menu_cb(PurpleE2eeProvider *provider,
@@ -217,9 +217,9 @@
 /**
  * Gets the conversation menu callback of the E2EE provider.
  *
- * @provider: The E2EE provider.
+ * @param provider The E2EE provider.
  *
- * Returns: The callback.
+ * @return The callback.
  */
 PurpleE2eeConvMenuCallback
 purple_e2ee_provider_get_conv_menu_cb(PurpleE2eeProvider *provider);