/soc/2013/ankitkv/gobjectification: bf3f004adbf1: Fix 'Returns:'

Ankit Vani a at nevitus.org
Fri Jan 31 08:17:04 EST 2014


Changeset: bf3f004adbf1764af085c1928d0dfbb2965a793f
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-01-31 18:45 +0530
Branch:	 gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/bf3f004adbf1

Description:

Fix 'Returns:'

diffstat:

 libpurple/mime.h          |  12 ++++++------
 libpurple/nat-pmp.h       |   4 ++--
 libpurple/network.h       |   2 +-
 libpurple/request.h       |   2 +-
 libpurple/sound-theme.h   |   4 ++--
 libpurple/theme-loader.h  |   6 +++---
 libpurple/theme-manager.h |   2 +-
 libpurple/xfer.h          |   2 +-
 pidgin/gtkblist-theme.h   |  32 ++++++++++++++++----------------
 pidgin/gtkblist.h         |   2 +-
 pidgin/gtkicon-theme.h    |   2 +-
 11 files changed, 35 insertions(+), 35 deletions(-)

diffs (truncated from 348 to 300 lines):

diff --git a/libpurple/mime.h b/libpurple/mime.h
--- a/libpurple/mime.h
+++ b/libpurple/mime.h
@@ -63,7 +63,7 @@ void purple_mime_document_free(PurpleMim
  *
  * @buf: The NULL-terminated string containing the MIME-encoded data.
  *
- * Returns:s A MIME document.
+ * Returns: A MIME document.
  */
 PurpleMimeDocument *purple_mime_document_parse(const char *buf);
 
@@ -73,7 +73,7 @@ PurpleMimeDocument *purple_mime_document
  * @buf: The string containing the MIME-encoded data.
  * @len: Length of buf.
  *
- * Returns:s   A MIME document.
+ * Returns:   A MIME document.
  */
 PurpleMimeDocument *purple_mime_document_parsen(const char *buf, gsize len);
 
@@ -98,7 +98,7 @@ GList *purple_mime_document_get_fields(P
  * @doc:   The MIME document.
  * @field: Case-insensitive field name.
  *
- * Returns:s     Value associated with the indicated header field, or
+ * Returns:     Value associated with the indicated header field, or
  *              NULL if the field doesn't exist.
  */
 const char *purple_mime_document_get_field(PurpleMimeDocument *doc,
@@ -151,7 +151,7 @@ GList *purple_mime_part_get_fields(Purpl
  * @part:  The MIME document part.
  * @field: Case-insensitive name of the header field.
  *
- * Returns:s     Value of the specified header field, or NULL if the
+ * Returns:     Value of the specified header field, or NULL if the
  *              field doesn't exist.
  */
 const char *purple_mime_part_get_field(PurpleMimePart *part,
@@ -182,7 +182,7 @@ void purple_mime_part_set_field(PurpleMi
  *
  * @part: The MIME document part.
  *
- * Returns:s    NULL-terminated data found in the document part
+ * Returns:    NULL-terminated data found in the document part
  */
 const char *purple_mime_part_get_data(PurpleMimePart *part);
 
@@ -203,7 +203,7 @@ void purple_mime_part_get_data_decoded(P
  * Get the length of the data portion of a MIME document part.
  *
  * @part: The MIME document part.
- * Returns:s    Length of the data in the document part.
+ * Returns:    Length of the data in the document part.
  */
 gsize purple_mime_part_get_length(PurpleMimePart *part);
 
diff --git a/libpurple/nat-pmp.h b/libpurple/nat-pmp.h
--- a/libpurple/nat-pmp.h
+++ b/libpurple/nat-pmp.h
@@ -62,7 +62,7 @@ char *purple_pmp_get_public_ip(void);
  * @lifetime:    The lifetime of the mapping. It is recommended that this
  *                    be PURPLE_PMP_LIFETIME.
  *
- * Returns:s TRUE if successful; FALSE if unsuccessful
+ * Returns: TRUE if successful; FALSE if unsuccessful
  */
 gboolean purple_pmp_create_map(PurplePmpType type, unsigned short privateport,
                                unsigned short publicport, int lifetime);
@@ -73,7 +73,7 @@ gboolean purple_pmp_create_map(PurplePmp
  * @type:        The PurplePmpType
  * @privateport: The private port on which the mapping was previously made
  *
- * Returns:s TRUE if successful; FALSE if unsuccessful
+ * Returns: TRUE if successful; FALSE if unsuccessful
  */
 gboolean purple_pmp_destroy_map(PurplePmpType type, unsigned short privateport);
 
diff --git a/libpurple/network.h b/libpurple/network.h
--- a/libpurple/network.h
+++ b/libpurple/network.h
@@ -285,7 +285,7 @@ void purple_network_remove_port_mapping(
  * @in:      The hostname to be converted.
  * @out:     The output buffer where an allocated string will be returned.
  *                The caller is responsible for freeing this.
- * Returns:s       0 on success, -1 if the out is NULL, or an error code
+ * Returns:       0 on success, -1 if the out is NULL, or an error code
  *                that currently corresponds to the Idna_rc enum in libidn.
  */
 int purple_network_convert_idn_to_ascii(const gchar *in, gchar **out);
diff --git a/libpurple/request.h b/libpurple/request.h
--- a/libpurple/request.h
+++ b/libpurple/request.h
@@ -309,7 +309,7 @@ purple_request_cpar_set_icon(PurpleReque
  *
  * @cpar: The parameters set.
  *
- * Returns:s icon_type The icon type.
+ * Returns: icon_type The icon type.
  */
 PurpleRequestIconType
 purple_request_cpar_get_icon(PurpleRequestCommonParameters *cpar);
diff --git a/libpurple/sound-theme.h b/libpurple/sound-theme.h
--- a/libpurple/sound-theme.h
+++ b/libpurple/sound-theme.h
@@ -81,7 +81,7 @@ GType purple_sound_theme_get_type(void);
  * @theme: The theme.
  * @event: The purple sound event to look up.
  *
- * Returns:s The filename of the sound event.
+ * Returns: The filename of the sound event.
  */
 const gchar *purple_sound_theme_get_file(PurpleSoundTheme *theme,
 		const gchar *event);
@@ -92,7 +92,7 @@ const gchar *purple_sound_theme_get_file
  * @theme: The theme.
  * @event: The purple sound event to look up
  *
- * Returns:s The directory + '/' + filename of the sound event.  This is
+ * Returns: The directory + '/' + filename of the sound event.  This is
  *          a newly allocated string that should be freed with g_free.
  */
 gchar *purple_sound_theme_get_file_full(PurpleSoundTheme *theme,
diff --git a/libpurple/theme-loader.h b/libpurple/theme-loader.h
--- a/libpurple/theme-loader.h
+++ b/libpurple/theme-loader.h
@@ -82,7 +82,7 @@ GType purple_theme_loader_get_type(void)
  *
  * @self: The theme loader
  *
- * Returns:s The string representing this type
+ * Returns: The string representing this type
  */
 const gchar *purple_theme_loader_get_type_string(PurpleThemeLoader *self);
 
@@ -92,7 +92,7 @@ const gchar *purple_theme_loader_get_typ
  * @loader: The theme loader
  * @dir:    The directory containing the theme
  *
- * Returns:s A PurpleTheme containing the information from the directory
+ * Returns: A PurpleTheme containing the information from the directory
  */
 PurpleTheme *purple_theme_loader_build(PurpleThemeLoader *loader, const gchar *dir);
 
@@ -106,7 +106,7 @@ PurpleTheme *purple_theme_loader_build(P
  * @loader: The theme loader
  * @dir:    The directory that may contain the theme
  *
- * Returns:s TRUE if the directory appears to contain a theme, FALSE otherwise.
+ * Returns: TRUE if the directory appears to contain a theme, FALSE otherwise.
  */
 gboolean purple_theme_loader_probe(PurpleThemeLoader *loader, const gchar *dir);
 
diff --git a/libpurple/theme-manager.h b/libpurple/theme-manager.h
--- a/libpurple/theme-manager.h
+++ b/libpurple/theme-manager.h
@@ -93,7 +93,7 @@ void purple_theme_manager_refresh(void);
  * @name: The name of the PurpleTheme.
  * @type: The type of the PurpleTheme.
  *
- * Returns:s The PurpleTheme, or NULL if it wasn't found.
+ * Returns: The PurpleTheme, or NULL if it wasn't found.
  */
 PurpleTheme *purple_theme_manager_find_theme(const gchar *name, const gchar *type);
 
diff --git a/libpurple/xfer.h b/libpurple/xfer.h
--- a/libpurple/xfer.h
+++ b/libpurple/xfer.h
@@ -108,7 +108,7 @@ typedef struct
 	 *                libpurple will free the data.
 	 * @size:    The maximum amount of data to put in the buffer.
 	 *
-	 * Returns:s The amount of data in the buffer, 0 if nothing is available,
+	 * Returns: The amount of data in the buffer, 0 if nothing is available,
 	 *          and a negative value if an error occurred and the transfer
 	 *          should be cancelled (libpurple will cancel).
 	 */
diff --git a/pidgin/gtkblist-theme.h b/pidgin/gtkblist-theme.h
--- a/pidgin/gtkblist-theme.h
+++ b/pidgin/gtkblist-theme.h
@@ -162,7 +162,7 @@ GType pidgin_blist_theme_get_type(void);
  *
  * @theme:  The PidginBlist theme.
  *
- * Returns:s A gdk color.
+ * Returns: A gdk color.
  */
  GdkColor *pidgin_blist_theme_get_background_color(PidginBlistTheme *theme);
 
@@ -172,7 +172,7 @@ GType pidgin_blist_theme_get_type(void);
  *
  * @theme:  The PidginBlist theme.
  *
- * Returns:s The opacity
+ * Returns: The opacity
  */
 gdouble pidgin_blist_theme_get_opacity(PidginBlistTheme *theme);
 
@@ -181,7 +181,7 @@ gdouble pidgin_blist_theme_get_opacity(P
  *
  * @theme:  The PidginBlist theme.
  *
- * Returns:s The buddy list layout.
+ * Returns: The buddy list layout.
  */
 PidginBlistLayout *pidgin_blist_theme_get_layout(PidginBlistTheme *theme);
 
@@ -190,7 +190,7 @@ PidginBlistLayout *pidgin_blist_theme_ge
  *
  * @theme:  The PidginBlist theme.
  *
- * Returns:s A gdk color.
+ * Returns: A gdk color.
  */
 GdkColor *pidgin_blist_theme_get_expanded_background_color(PidginBlistTheme *theme);
 
@@ -199,7 +199,7 @@ GdkColor *pidgin_blist_theme_get_expande
  *
  * @theme:  The PidginBlist theme.
  *
- * Returns:s A font and color pair.
+ * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_expanded_text_info(PidginBlistTheme *theme);
 
@@ -208,7 +208,7 @@ PidginThemeFont *pidgin_blist_theme_get_
  *
  * @theme:  The PidginBlist theme.
  *
- * Returns:s A gdk color.
+ * Returns: A gdk color.
  */
 GdkColor *pidgin_blist_theme_get_collapsed_background_color(PidginBlistTheme *theme);
 
@@ -217,7 +217,7 @@ GdkColor *pidgin_blist_theme_get_collaps
  *
  * @theme:  The PidginBlist theme.
  *
- * Returns:s A font and color pair.
+ * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_collapsed_text_info(PidginBlistTheme *theme);
 
@@ -226,7 +226,7 @@ PidginThemeFont *pidgin_blist_theme_get_
  *
  * @theme:  The PidginBlist theme.
  *
- * Returns:s A gdkcolor for contacts and chats.
+ * Returns: A gdkcolor for contacts and chats.
  */
 GdkColor *pidgin_blist_theme_get_contact_color(PidginBlistTheme *theme);
 
@@ -235,7 +235,7 @@ GdkColor *pidgin_blist_theme_get_contact
  *
  * @theme:  The PidginBlist theme.
  *
- * Returns:s A font and color pair.
+ * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_contact_text_info(PidginBlistTheme *theme);
 
@@ -244,7 +244,7 @@ PidginThemeFont *pidgin_blist_theme_get_
  *
  * @theme:  The PidginBlist theme.
  *
- * Returns:s A font and color pair.
+ * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_online_text_info(PidginBlistTheme *theme);
 
@@ -253,7 +253,7 @@ PidginThemeFont *pidgin_blist_theme_get_
  *
  * @theme:  The PidginBlist theme.
  *
- * Returns:s A font and color pair.
+ * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_away_text_info(PidginBlistTheme *theme);
 
@@ -262,7 +262,7 @@ PidginThemeFont *pidgin_blist_theme_get_
  *
  * @theme:  The PidginBlist theme.
  *
- * Returns:s A font and color pair.
+ * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_offline_text_info(PidginBlistTheme *theme);
 
@@ -271,7 +271,7 @@ PidginThemeFont *pidgin_blist_theme_get_
  *
  * @theme:  The PidginBlist theme.
  *
- * Returns:s A font and color pair.
+ * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_idle_text_info(PidginBlistTheme *theme);
 
@@ -280,7 +280,7 @@ PidginThemeFont *pidgin_blist_theme_get_
  *
  * @theme:  The PidginBlist theme.



More information about the Commits mailing list