Mercurial > pidgin3 / file diff

diff: libpurple/pluginpref.h

libpurple/pluginpref.h

branch
soc.2013.gobjectification.plugins
changeset 37023
d9bcdc9a91e6
parent 37022
d891503c8aa6
child 37034
9d6765962b22
--- a/libpurple/pluginpref.h	Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/pluginpref.h	Wed Jan 29 10:49:02 2014 +0530
@@ -60,184 +60,184 @@
 /**
  * Create a new plugin preference frame
  *
- * Returns: a new PurplePluginPrefFrame
+ * @return a new PurplePluginPrefFrame
  */
 PurplePluginPrefFrame *purple_plugin_pref_frame_new(void);
 
 /**
  * Destroy a plugin preference frame
  *
- * @frame: The plugin frame to destroy
+ * @param frame The plugin frame to destroy
  */
 void purple_plugin_pref_frame_destroy(PurplePluginPrefFrame *frame);
 
 /**
  * Adds a plugin preference to a plugin preference frame
  *
- * @frame: The plugin frame to add the preference to
- * @pref:  The preference to add to the frame
+ * @param frame The plugin frame to add the preference to
+ * @param pref  The preference to add to the frame
  */
 void purple_plugin_pref_frame_add(PurplePluginPrefFrame *frame, PurplePluginPref *pref);
 
 /**
  * Get the plugin preferences from a plugin preference frame
  *
- * @frame: The plugin frame to get the plugin preferences from
- * Returns: (transfer none): a GList of plugin preferences
+ * @param frame The plugin frame to get the plugin preferences from
+ * @constreturn a GList of plugin preferences
  */
 GList *purple_plugin_pref_frame_get_prefs(PurplePluginPrefFrame *frame);
 
 /**
  * Create a new plugin preference
  *
- * Returns: a new PurplePluginPref
+ * @return a new PurplePluginPref
  */
 PurplePluginPref *purple_plugin_pref_new(void);
 
 /**
  * Create a new plugin preference with name
  *
- * @name: The name of the pref
- * Returns: a new PurplePluginPref
+ * @param name The name of the pref
+ * @return a new PurplePluginPref
  */
 PurplePluginPref *purple_plugin_pref_new_with_name(const char *name);
 
 /**
  * Create a new plugin preference with label
  *
- * @label: The label to be displayed
- * Returns: a new PurplePluginPref
+ * @param label The label to be displayed
+ * @return a new PurplePluginPref
  */
 PurplePluginPref *purple_plugin_pref_new_with_label(const char *label);
 
 /**
  * Create a new plugin preference with name and label
  *
- * @name:  The name of the pref
- * @label: The label to be displayed
- * Returns: a new PurplePluginPref
+ * @param name  The name of the pref
+ * @param label The label to be displayed
+ * @return a new PurplePluginPref
  */
 PurplePluginPref *purple_plugin_pref_new_with_name_and_label(const char *name, const char *label);
 
 /**
  * Destroy a plugin preference
  *
- * @pref: The preference to destroy
+ * @param pref The preference to destroy
  */
 void purple_plugin_pref_destroy(PurplePluginPref *pref);
 
 /**
  * Set a plugin pref name
  *
- * @pref: The plugin pref
- * @name: The name of the pref
+ * @param pref The plugin pref
+ * @param name The name of the pref
  */
 void purple_plugin_pref_set_name(PurplePluginPref *pref, const char *name);
 
 /**
  * Get a plugin pref name
  *
- * @pref: The plugin pref
- * Returns: The name of the pref
+ * @param pref The plugin pref
+ * @return The name of the pref
  */
 const char *purple_plugin_pref_get_name(PurplePluginPref *pref);
 
 /**
  * Set a plugin pref label
  *
- * @pref:  The plugin pref
- * @label: The label for the plugin pref
+ * @param pref  The plugin pref
+ * @param label The label for the plugin pref
  */
 void purple_plugin_pref_set_label(PurplePluginPref *pref, const char *label);
 
 /**
  * Get a plugin pref label
  *
- * @pref: The plugin pref
- * Returns: The label for the plugin pref
+ * @param pref The plugin pref
+ * @return The label for the plugin pref
  */
 const char *purple_plugin_pref_get_label(PurplePluginPref *pref);
 
 /**
  * Set the bounds for an integer pref
  *
- * @pref: The plugin pref
- * @min:  The min value
- * @max:  The max value
+ * @param pref The plugin pref
+ * @param min  The min value
+ * @param max  The max value
  */
 void purple_plugin_pref_set_bounds(PurplePluginPref *pref, int min, int max);
 
 /**
  * Get the bounds for an integer pref
  *
- * @pref: The plugin pref
- * @min:  The min value
- * @max:  The max value
+ * @param pref The plugin pref
+ * @param min  The min value
+ * @param max  The max value
  */
 void purple_plugin_pref_get_bounds(PurplePluginPref *pref, int *min, int *max);
 
 /**
  * Set the type of a plugin pref
  *
- * @pref: The plugin pref
- * @type: The type
+ * @param pref The plugin pref
+ * @param type The type
  */
 void purple_plugin_pref_set_type(PurplePluginPref *pref, PurplePluginPrefType type);
 
 /**
  * Get the type of a plugin pref
  *
- * @pref: The plugin pref
- * Returns: The type
+ * @param pref The plugin pref
+ * @return The type
  */
 PurplePluginPrefType purple_plugin_pref_get_type(PurplePluginPref *pref);
 
 /**
  * Set the choices for a choices plugin pref
  *
- * @pref:  The plugin pref
- * @label: The label for the choice
- * @choice:  A gpointer of the choice
+ * @param pref  The plugin pref
+ * @param label The label for the choice
+ * @param choice  A gpointer of the choice
  */
 void purple_plugin_pref_add_choice(PurplePluginPref *pref, const char *label, gpointer choice);
 
 /**
  * Get the choices for a choices plugin pref
  *
- * @pref: The plugin pref
- * Returns: (transfer none): GList of the choices
+ * @param pref The plugin pref
+ * @constreturn GList of the choices
  */
 GList *purple_plugin_pref_get_choices(PurplePluginPref *pref);
 
 /**
  * Set the max length for a string plugin pref
  *
- * @pref:       The plugin pref
- * @max_length: The max length of the string
+ * @param pref       The plugin pref
+ * @param max_length The max length of the string
  */
 void purple_plugin_pref_set_max_length(PurplePluginPref *pref, unsigned int max_length);
 
 /**
  * Get the max length for a string plugin pref
  *
- * @pref: The plugin pref
- * Returns: the max length
+ * @param pref The plugin pref
+ * @return the max length
  */
 unsigned int purple_plugin_pref_get_max_length(PurplePluginPref *pref);
 
 /**
  * Sets the masking of a string plugin pref
  *
- * @pref: The plugin pref
- * @mask: The value to set
+ * @param pref The plugin pref
+ * @param mask The value to set
  */
 void purple_plugin_pref_set_masked(PurplePluginPref *pref, gboolean mask);
 
 /**
  * Gets the masking of a string plugin pref
  *
- * @pref: The plugin pref
- * Returns: The masking
+ * @param pref The plugin pref
+ * @return The masking
  */
 gboolean purple_plugin_pref_get_masked(PurplePluginPref *pref);
 
@@ -245,16 +245,16 @@
  * Sets the format type for a formattable-string plugin pref. You need to set the
  * pref type to PURPLE_PLUGIN_PREF_STRING_FORMAT first before setting the format.
  *
- * @pref:	 The plugin pref
- * @format: The format of the string
+ * @param pref	 The plugin pref
+ * @param format The format of the string
  */
 void purple_plugin_pref_set_format_type(PurplePluginPref *pref, PurpleStringFormatType format);
 
 /**
  * Gets the format type of the formattable-string plugin pref.
  *
- * @pref: The plugin pref
- * Returns: The format of the pref
+ * @param pref The plugin pref
+ * @return The format of the pref
  */
 PurpleStringFormatType purple_plugin_pref_get_format_type(PurplePluginPref *pref);

Mercurial Repository: pidgin3

mercurial