changeset 32176:5aa171c8776b

Fix a bunch of tiny problems generating our doxygen documentation
author Mark Doliner <mark@kingant.net>
date Sun, 18 Sep 2011 20:46:06 +0000
parents a617a949e545
children 2626b555d85f
files libpurple/ft.h libpurple/notify.h libpurple/prpl.c libpurple/prpl.h libpurple/request.c libpurple/request.h libpurple/roomlist.h libpurple/util.h libpurple/whiteboard.h libpurple/xmlnode.h pidgin/gtkutils.h pidgin/gtkwebview.h
diffstat 12 files changed, 33 insertions(+), 31 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/ft.h	Sun Sep 18 20:20:02 2011 +0000
+++ b/libpurple/ft.h	Sun Sep 18 20:46:06 2011 +0000
@@ -791,7 +791,7 @@
  * Sets the protocol data for a file transfer.
  *
  * @param xfer			The file transfer.
- * @param protocol_data	The protocol data to set for the file transfer.
+ * @param proto_data	The protocol data to set for the file transfer.
  *
  * @since 3.0.0
  */
--- a/libpurple/notify.h	Sun Sep 18 20:20:02 2011 +0000
+++ b/libpurple/notify.h	Sun Sep 18 20:46:06 2011 +0000
@@ -279,7 +279,7 @@
 /**
  * Sets whether or not a search result column is visible.
  *
- * @param field   The search column object.
+ * @param column  The search column object.
  * @param visible TRUE if visible, or FALSE if not.
  */
 void purple_notify_searchresult_column_set_visible(PurpleNotifySearchColumn *column, gboolean visible);
@@ -287,7 +287,7 @@
 /**
  * Returns whether or not a search result column is visible.
  *
- * @param field The search column object.
+ * @param column The search column object.
  *
  * @return TRUE if the search result column is visible. FALSE otherwise.
  */
--- a/libpurple/prpl.c	Sun Sep 18 20:20:02 2011 +0000
+++ b/libpurple/prpl.c	Sun Sep 18 20:46:06 2011 +0000
@@ -33,9 +33,6 @@
 /** @name Attention Type API                                              */
 /**************************************************************************/
 
-/** Represents "nudges" and "buzzes" that you may send to a buddy to attract
- *  their attention (or vice-versa).
- */
 struct _PurpleAttentionType
 {
 	const char *name;                  /**< Shown in GUI elements */
--- a/libpurple/prpl.h	Sun Sep 18 20:20:02 2011 +0000
+++ b/libpurple/prpl.h	Sun Sep 18 20:46:06 2011 +0000
@@ -31,7 +31,10 @@
 #define _PURPLE_PRPL_H_
 
 typedef struct _PurplePluginProtocolInfo PurplePluginProtocolInfo;
-/** @copydoc _PurpleAttentionType */
+
+/** Represents "nudges" and "buzzes" that you may send to a buddy to attract
+ *  their attention (or vice-versa).
+ */
 typedef struct _PurpleAttentionType PurpleAttentionType;
 
 /**************************************************************************/
--- a/libpurple/request.c	Sun Sep 18 20:20:02 2011 +0000
+++ b/libpurple/request.c	Sun Sep 18 20:46:06 2011 +0000
@@ -42,9 +42,6 @@
 
 } PurpleRequestInfo;
 
-/**
- * A request field.
- */
 struct _PurpleRequestField
 {
 	PurpleRequestFieldType type;
--- a/libpurple/request.h	Sun Sep 18 20:20:02 2011 +0000
+++ b/libpurple/request.h	Sun Sep 18 20:46:06 2011 +0000
@@ -30,7 +30,9 @@
 #include <glib-object.h>
 #include <glib.h>
 
-/** @copydoc _PurpleRequestField */
+/**
+ * A request field.
+ */
 typedef struct _PurpleRequestField PurpleRequestField;
 
 /**
@@ -321,7 +323,7 @@
  * @param fields The fields list.
  * @param ui_data A pointer to associate with this object.
  */
-void purple_request_fields_set_ui_data(PurpleRequestFields *fields, gpointer data);
+void purple_request_fields_set_ui_data(PurpleRequestFields *fields, gpointer ui_data);
 
 /*@}*/
 
--- a/libpurple/roomlist.h	Sun Sep 18 20:20:02 2011 +0000
+++ b/libpurple/roomlist.h	Sun Sep 18 20:46:06 2011 +0000
@@ -224,7 +224,7 @@
 /**
  * Get the protocol data associated with this room list.
  *
- * @param roomlist The roomlist, which must not be @c NULL.
+ * @param list The roomlist, which must not be @c NULL.
  *
  * @return The protocol data associated with this room list.  This is a
  *         convenience field provided to the protocol plugin--it is not
@@ -243,7 +243,7 @@
 /**
  * Get the UI data associated with this room list.
  *
- * @param roomlist The roomlist, which must not be @c NULL.
+ * @param list The roomlist, which must not be @c NULL.
  *
  * @return The UI data associated with this room list.  This is a
  *         convenience field provided to the UIs--it is not
@@ -255,7 +255,7 @@
  * Set the UI data associated with this room list.
  *
  * @param list The roomlist, which must not be @c NULL.
- * @param UI_data A pointer to associate with this room list.
+ * @param ui_data A pointer to associate with this room list.
  */
 void purple_roomlist_set_ui_data(PurpleRoomlist *list, gpointer ui_data);
 
--- a/libpurple/util.h	Sun Sep 18 20:20:02 2011 +0000
+++ b/libpurple/util.h	Sun Sep 18 20:46:06 2011 +0000
@@ -36,9 +36,16 @@
   * the request.
   */
 typedef struct _PurpleUtilFetchUrlData PurpleUtilFetchUrlData;
+
 /** @copydoc _PurpleMenuAction */
 typedef struct _PurpleMenuAction PurpleMenuAction;
-/** @copydoc _PurpleKeyValuePair */
+
+/**
+ * A key-value pair.
+ *
+ * This is used by, among other things, purple_gtk_combo* functions to pass in a
+ * list of key-value pairs so it can display a user-friendly value.
+ */
 typedef struct _PurpleKeyValuePair PurpleKeyValuePair;
 
 #include "account.h"
@@ -53,12 +60,6 @@
 
 typedef char *(*PurpleInfoFieldFormatCallback)(const char *field, size_t len);
 
-/**
- * A key-value pair.
- *
- * This is used by, among other things, purple_gtk_combo* functions to pass in a
- * list of key-value pairs so it can display a user-friendly value.
- */
 struct _PurpleKeyValuePair
 {
 	gchar *key;
--- a/libpurple/whiteboard.h	Sun Sep 18 20:20:02 2011 +0000
+++ b/libpurple/whiteboard.h	Sun Sep 18 20:46:06 2011 +0000
@@ -309,10 +309,10 @@
  * Sets the protocol data for a whiteboard.
  *
  * @param wb			The whiteboard.
- * @param protocol_data	The protocol data to set for the whiteboard.
+ * @param proto_data	The protocol data to set for the whiteboard.
  */
 void purple_whiteboard_set_protocol_data(PurpleWhiteboard *wb, gpointer proto_data);
- 
+
 /**
  * Gets the protocol data for a whiteboard.
  *
--- a/libpurple/xmlnode.h	Sun Sep 18 20:20:02 2011 +0000
+++ b/libpurple/xmlnode.h	Sun Sep 18 20:46:06 2011 +0000
@@ -230,9 +230,11 @@
  * own namespace.
  *
  * For example, given:
+ * \verbatim
  * <iq type='get' xmlns='jabber:client' xmlns:ns1='http://example.org/ns1'>
  *     <ns1:element><child1/></ns1:element>
  * </iq>
+ * \endverbatim
  *
  * The default namespace of all nodes (including 'child1') is "jabber:client",
  * though the namespace for 'element' is "http://example.org/ns1".
--- a/pidgin/gtkutils.h	Sun Sep 18 20:20:02 2011 +0000
+++ b/pidgin/gtkutils.h	Sun Sep 18 20:46:06 2011 +0000
@@ -928,12 +928,12 @@
 
 /**
  * Add scrollbars to a widget
- * @param widget      The child widget
- * @hscrollbar_policy Horizontal scrolling policy
- * @vscrollbar_policy Vertical scrolling policy
- * @shadow            Shadow type
- * @width             Desired widget width, or -1 for default
- * @height            Desired widget height, or -1 for default
+ * @param child              The child widget
+ * @param hscrollbar_policy  Horizontal scrolling policy
+ * @param vscrollbar_policy  Vertical scrolling policy
+ * @param shadow_type        Shadow type
+ * @param width              Desired widget width, or -1 for default
+ * @param height             Desired widget height, or -1 for default
  *
  * @since 2.8.0
  */
--- a/pidgin/gtkwebview.h	Sun Sep 18 20:20:02 2011 +0000
+++ b/pidgin/gtkwebview.h	Sun Sep 18 20:46:06 2011 +0000
@@ -94,7 +94,7 @@
 
 /**
  * Rather than use webkit_webview_load_string, this routine
- * parses and displays the <img id=?> tags that make use of the
+ * parses and displays the \<img id=?\> tags that make use of the
  * Pidgin imgstore.
  *
  * @param webview The GtkWebView object