changeset 20891:59c9c04879af

Replace a bunch of @return markers with @constreturn markers. I believe these are all correct.
author Etan Reisner <pidgin@unreliablesource.net>
date Wed, 17 Oct 2007 03:36:54 +0000
parents 086b6e3e5015
children 216fdae447a9
files libpurple/conversation.h libpurple/plugin.h libpurple/pluginpref.h libpurple/pounce.h libpurple/request.h
diffstat 5 files changed, 10 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/conversation.h	Fri Oct 12 03:49:39 2007 +0000
+++ b/libpurple/conversation.h	Wed Oct 17 03:36:54 2007 +0000
@@ -1042,7 +1042,7 @@
  *
  * @param chat The chat.
  *
- * @return The list of ignored users.
+ * @constreturn The list of ignored users.
  */
 GList *purple_conv_chat_get_ignored(const PurpleConvChat *chat);
 
--- a/libpurple/plugin.h	Fri Oct 12 03:49:39 2007 +0000
+++ b/libpurple/plugin.h	Wed Oct 17 03:36:54 2007 +0000
@@ -612,7 +612,7 @@
 /**
  * Returns a list of all loaded plugins.
  *
- * @return A list of all loaded plugins.
+ * @constreturn A list of all loaded plugins.
  */
 GList *purple_plugins_get_loaded(void);
 
@@ -622,14 +622,14 @@
  * to the PURPLE_INIT_PLUGIN() macro, or if it was compiled
  * against an incompatable API version.
  *
- * @return A list of all protocol plugins.
+ * @constreturn A list of all protocol plugins.
  */
 GList *purple_plugins_get_protocols(void);
 
 /**
  * Returns a list of all plugins, whether loaded or not.
  *
- * @return A list of all plugins.
+ * @constreturn A list of all plugins.
  */
 GList *purple_plugins_get_all(void);
 
--- a/libpurple/pluginpref.h	Fri Oct 12 03:49:39 2007 +0000
+++ b/libpurple/pluginpref.h	Wed Oct 17 03:36:54 2007 +0000
@@ -85,7 +85,7 @@
  * Get the plugin preferences from a plugin preference frame
  *
  * @param frame The plugin frame to get the plugin preferences from
- * @return a GList of plugin preferences
+ * @constreturn a GList of plugin preferences
  */
 GList *purple_plugin_pref_frame_get_prefs(PurplePluginPrefFrame *frame);
 
@@ -207,7 +207,7 @@
  * Get the choices for a choices plugin pref
  *
  * @param pref The plugin pref
- * @return GList of the choices 
+ * @constreturn GList of the choices
  */
 GList *purple_plugin_pref_get_choices(PurplePluginPref *pref);
 
--- a/libpurple/pounce.h	Fri Oct 12 03:49:39 2007 +0000
+++ b/libpurple/pounce.h	Wed Oct 17 03:36:54 2007 +0000
@@ -339,7 +339,7 @@
 /**
  * Returns a list of all registered buddy pounces.
  *
- * @return The list of buddy pounces.
+ * @constreturn The list of buddy pounces.
  */
 GList *purple_pounces_get_all(void);
 
--- a/libpurple/request.h	Fri Oct 12 03:49:39 2007 +0000
+++ b/libpurple/request.h	Wed Oct 17 03:36:54 2007 +0000
@@ -266,7 +266,7 @@
  *
  * @param fields The fields list.
  *
- * @return A list of groups.
+ * @constreturn A list of groups.
  */
 GList *purple_request_fields_get_groups(const PurpleRequestFields *fields);
 
@@ -424,7 +424,7 @@
  *
  * @param group The group.
  *
- * @return The list of fields in the group.
+ * @constreturn The list of fields in the group.
  */
 GList *purple_request_field_group_get_fields(
 		const PurpleRequestFieldGroup *group);
@@ -836,7 +836,7 @@
  *
  * @param field The field.
  *
- * @return The list of labels.
+ * @constreturn The list of labels.
  */
 GList *purple_request_field_choice_get_labels(const PurpleRequestField *field);