/soc/2013/ankitkv/gobjectification: cad6397a56cf: Change some re...
Ankit Vani
a at nevitus.org
Wed Jan 29 14:20:03 EST 2014
Changeset: cad6397a56cfad1049324e98a270c6320daba263
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-30 00:49 +0530
Branch: soc.2013.gobjectification.gtkdoc
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/cad6397a56cf
Description:
Change some remaining '@param var' commands to '@var:'
diffstat:
finch/gntblist.h | 8 ++++----
finch/libgnt/gnt.h | 4 ++--
finch/libgnt/gntutils.h | 2 +-
finch/libgnt/gntwidget.h | 12 ++++++------
finch/libgnt/gntwm.h | 10 +++++-----
libpurple/cmds.h | 4 ++--
libpurple/log.h | 8 ++++----
libpurple/notify.h | 2 +-
libpurple/request.h | 4 ++--
libpurple/server.h | 4 ++--
libpurple/util.h | 26 +++++++++++++-------------
libpurple/whiteboard.h | 4 ++--
pidgin/gtkdnd-hints.h | 4 ++--
pidgin/gtkimhtml.h | 2 +-
pidgin/gtkutils.h | 20 ++++++++++----------
pidgin/pidgintooltip.h | 8 ++++----
16 files changed, 61 insertions(+), 61 deletions(-)
diffs (truncated from 406 to 300 lines):
diff --git a/finch/gntblist.h b/finch/gntblist.h
--- a/finch/gntblist.h
+++ b/finch/gntblist.h
@@ -77,8 +77,8 @@ void finch_blist_show(void);
/**
* Get the position of the buddy list.
*
- * @param x The x-coordinate is set here if not @ NULL.
- * @param y The y-coordinate is set here if not %NULL.
+ * @x: The x-coordinate is set here if not @ NULL.
+ * @y: The y-coordinate is set here if not %NULL.
*
* Returns: Returns %TRUE if the values were set, %FALSE otherwise.
*/
@@ -87,8 +87,8 @@ gboolean finch_blist_get_position(int *x
/**
* Set the position of the buddy list.
*
- * @param x The x-coordinate of the buddy list.
- * @param y The y-coordinate of the buddy list.
+ * @x: The x-coordinate of the buddy list.
+ * @y: The y-coordinate of the buddy list.
*/
void finch_blist_set_position(int x, int y);
diff --git a/finch/libgnt/gnt.h b/finch/libgnt/gnt.h
--- a/finch/libgnt/gnt.h
+++ b/finch/libgnt/gnt.h
@@ -97,8 +97,8 @@ void gnt_screen_resize_widget(GntWidget
* Move a widget.
*
* @widget: The widget to move.
- * @param x The desired x-coordinate.
- * @param y The desired y-coordinate.
+ * @x: The desired x-coordinate.
+ * @y: The desired y-coordinate.
*/
void gnt_screen_move_widget(GntWidget *widget, int x, int y);
diff --git a/finch/libgnt/gntutils.h b/finch/libgnt/gntutils.h
--- a/finch/libgnt/gntutils.h
+++ b/finch/libgnt/gntutils.h
@@ -59,7 +59,7 @@ int gnt_util_onscreen_width(const char *
*
* @str: The string.
* @len: The length to consider. If non-positive, the entire screenlength is used.
- * @param w The actual width of the string upto the returned offset, if not %NULL.
+ * @w: The actual width of the string upto the returned offset, if not %NULL.
*
* Returns: The string after len offset.
*/
diff --git a/finch/libgnt/gntwidget.h b/finch/libgnt/gntwidget.h
--- a/finch/libgnt/gntwidget.h
+++ b/finch/libgnt/gntwidget.h
@@ -180,16 +180,16 @@ void gnt_widget_hide(GntWidget *widget);
* Get the position of a widget.
*
* @widget: The widget.
- * @param x Location to store the x-coordinate of the widget.
- * @param y Location to store the y-coordinate of the widget.
+ * @x: Location to store the x-coordinate of the widget.
+ * @y: Location to store the y-coordinate of the widget.
*/
void gnt_widget_get_position(GntWidget *widget, int *x, int *y);
/**
* Set the position of a widget.
* @widget: The widget to reposition.
- * @param x The x-coordinate of the widget.
- * @param y The x-coordinate of the widget.
+ * @x: The x-coordinate of the widget.
+ * @y: The x-coordinate of the widget.
*/
void gnt_widget_set_position(GntWidget *widget, int x, int y);
@@ -244,8 +244,8 @@ gboolean gnt_widget_key_pressed(GntWidge
*
* @widget: The widget.
* @event: The mouseevent.
- * @param x The x-coordinate of the mouse.
- * @param y The y-coordinate of the mouse.
+ * @x: The x-coordinate of the mouse.
+ * @y: The y-coordinate of the mouse.
*
* Returns: %TRUE if the event was handled, %FALSE otherwise.
*/
diff --git a/finch/libgnt/gntwm.h b/finch/libgnt/gntwm.h
--- a/finch/libgnt/gntwm.h
+++ b/finch/libgnt/gntwm.h
@@ -198,7 +198,7 @@ void gnt_wm_add_workspace(GntWM *wm, Gnt
/**
* Switch to a workspace.
* @wm: The window-manager.
- * @param n Index of the workspace to switch to.
+ * @n: Index of the workspace to switch to.
*
* Returns: %TRUE if the switch was successful.
*/
@@ -275,8 +275,8 @@ gboolean gnt_wm_process_input(GntWM *wm,
* Process a click event.
* @wm: The window manager.
* @event: The mouse event.
- * @param x The x-coordinate of the mouse.
- * @param y The y-coordinate of the mouse.
+ * @x: The x-coordinate of the mouse.
+ * @y: The y-coordinate of the mouse.
* @widget: The widget under the mouse.
*
* Returns: %TRUE if the event was handled, %FALSE otherwise.
@@ -296,8 +296,8 @@ void gnt_wm_resize_window(GntWM *wm, Gnt
* Move a window.
* @wm: The window manager.
* @widget: The window to move.
- * @param x The desired x-coordinate of the window.
- * @param y The desired y-coordinate of the window.
+ * @x: The desired x-coordinate of the window.
+ * @y: The desired y-coordinate of the window.
*/
void gnt_wm_move_window(GntWM *wm, GntWidget *widget, int x, int y);
diff --git a/libpurple/cmds.h b/libpurple/cmds.h
--- a/libpurple/cmds.h
+++ b/libpurple/cmds.h
@@ -132,10 +132,10 @@ G_BEGIN_DECLS
* terminated array of %NULL terminated strings, and will always
* match the number of arguments asked for, unless
* #PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS is passed.
- * @param p This is the priority. Higher priority commands will be run first,
+ * @p: This is the priority. Higher priority commands will be run first,
* and usually the first command will stop any others from being
* called.
- * @param f Flags specifying various options about this command, combined with
+ * @f: Flags specifying various options about this command, combined with
* <tt>|</tt> (bitwise OR). You need to at least pass one of
* #PURPLE_CMD_FLAG_IM or #PURPLE_CMD_FLAG_CHAT (you may pass both) in
* order for the command to ever actually be called.
diff --git a/libpurple/log.h b/libpurple/log.h
--- a/libpurple/log.h
+++ b/libpurple/log.h
@@ -346,8 +346,8 @@ char *purple_log_get_log_dir(PurpleLogTy
/**
* Implements GCompareFunc for PurpleLogs
*
- * @param y A PurpleLog
- * @param z Another PurpleLog
+ * @y: A PurpleLog
+ * @z: Another PurpleLog
* Returns: A value as specified by GCompareFunc
*/
gint purple_log_compare(gconstpointer y, gconstpointer z);
@@ -355,8 +355,8 @@ gint purple_log_compare(gconstpointer y,
/**
* Implements GCompareFunc for PurpleLogSets
*
- * @param y A PurpleLogSet
- * @param z Another PurpleLogSet
+ * @y: A PurpleLogSet
+ * @z: Another PurpleLogSet
* Returns: A value as specified by GCompareFunc
*/
gint purple_log_set_compare(gconstpointer y, gconstpointer z);
diff --git a/libpurple/notify.h b/libpurple/notify.h
--- a/libpurple/notify.h
+++ b/libpurple/notify.h
@@ -118,7 +118,7 @@ typedef enum
/**
* Callback for a button in a search result.
*
- * @param c the PurpleConnection passed to purple_notify_searchresults
+ * @c: the PurpleConnection passed to purple_notify_searchresults
* @row: the contents of the selected row
* @user_data: User defined data.
*/
diff --git a/libpurple/request.h b/libpurple/request.h
--- a/libpurple/request.h
+++ b/libpurple/request.h
@@ -1490,8 +1490,8 @@ PurpleRequestField *purple_request_field
* Sets the scale factors of an image field.
*
* @field: The image field.
- * @param x The x scale factor.
- * @param y The y scale factor.
+ * @x: The x scale factor.
+ * @y: The y scale factor.
*/
void purple_request_field_image_set_scale(PurpleRequestField *field, unsigned int x, unsigned int y);
diff --git a/libpurple/server.h b/libpurple/server.h
--- a/libpurple/server.h
+++ b/libpurple/server.h
@@ -164,7 +164,7 @@ void purple_serv_got_join_chat_failed(Pu
/**
* Called by a protocol when an account has left a chat.
*
- * @param g The connection on which the chat was left.
+ * @g: The connection on which the chat was left.
* @id: The id of the chat, as assigned by the protocol.
*/
void serv_got_chat_left(PurpleConnection *g, int id);
@@ -172,7 +172,7 @@ void serv_got_chat_left(PurpleConnection
/**
* Called by a protocol when a message has been received in a chat.
*
- * @param g The connection on which the message was received.
+ * @g: The connection on which the message was received.
* @id: The id of the chat, as assigned by the protocol.
* @who: The name of the user who sent the message.
* @flags: The flags of the message.
diff --git a/libpurple/util.h b/libpurple/util.h
--- a/libpurple/util.h
+++ b/libpurple/util.h
@@ -647,9 +647,9 @@ char *purple_unescape_html(const char *h
* work out any problems encountered.
*
* @str: The input NUL terminated, HTML, UTF-8 (or ASCII) string.
- * @param x The character offset into an unformatted version of str to
+ * @x: The character offset into an unformatted version of str to
* begin at.
- * @param y The character offset (into an unformatted vesion of str) of
+ * @y: The character offset (into an unformatted vesion of str) of
* one past the last character to include in the slice.
*
* Returns: The HTML slice of string, with all formatting retained.
@@ -986,8 +986,8 @@ gboolean purple_validate(const PurplePro
* Compares two strings to see if the first contains the second as
* a proper prefix.
*
- * @param s The string to check.
- * @param p The prefix in question.
+ * @s: The string to check.
+ * @p: The prefix in question.
*
* Returns: TRUE if p is a prefix of s, otherwise FALSE.
*/
@@ -997,8 +997,8 @@ gboolean purple_str_has_prefix(const cha
* Compares two strings to see if the second is a proper suffix
* of the first.
*
- * @param s The string to check.
- * @param x The suffix in question.
+ * @s: The string to check.
+ * @x: The suffix in question.
*
* Returns: TRUE if x is a a suffix of s, otherwise FALSE.
*/
@@ -1334,12 +1334,12 @@ const gchar *purple_gai_strerror(gint er
* it calls g_utf8_casefold() on each string, which allocates new
* strings.
*
- * @param a The first string.
- * @param b The second string.
+ * @a: The first string.
+ * @b: The second string.
*
- * Returns: -1 if @a a is less than @a b.
- * 0 if @a a is equal to @a b.
- * 1 if @a a is greater than @a b.
+ * Returns: -1 if @a is less than @b.
+ * 0 if @a is equal to @b.
+ * 1 if @a is greater than @b.
*/
int purple_utf8_strcasecmp(const char *a, const char *b);
@@ -1393,9 +1393,9 @@ char *purple_text_strip_mnemonic(const c
*
* Blame SimGuy.
*
- * @param x The number to add 8 to.
+ * @x: The number to add 8 to.
*
- * Returns: x + 8
+ * Returns: @x + 8
*/
#define purple_add_eight(x) ((x)+8)
diff --git a/libpurple/whiteboard.h b/libpurple/whiteboard.h
--- a/libpurple/whiteboard.h
+++ b/libpurple/whiteboard.h
@@ -233,8 +233,8 @@ void purple_whiteboard_set_dimensions(Pu
* Draws a point on a whiteboard.
*
* @wb: The whiteboard.
- * @param x The x coordinate.
- * @param y The y coordinate.
+ * @x: The x coordinate.
+ * @y: The y coordinate.
* @color: The color to use.
* @size: The brush size.
*/
diff --git a/pidgin/gtkdnd-hints.h b/pidgin/gtkdnd-hints.h
--- a/pidgin/gtkdnd-hints.h
+++ b/pidgin/gtkdnd-hints.h
@@ -58,8 +58,8 @@ G_BEGIN_DECLS
* Shows a drag-and-drop hint at the specified location.
*
* @id: The ID of the hint to show.
- * @param x The X location to show it at.
- * @param y The Y location to show it at.
+ * @x: The X location to show it at.
+ * @y: The Y location to show it at.
More information about the Commits
mailing list