pidgin: 0db2ee95: Fix a bunch of tiny problems generating ...

markdoliner at pidgin.im markdoliner at pidgin.im
Sun Sep 18 16:50:27 EDT 2011


----------------------------------------------------------------------
Revision: 0db2ee950691f472e16129df7c60cda547f1ede7
Parent:   d0d1612fb8120e1f47b7f9a119dce1d46c53e320
Author:   markdoliner at pidgin.im
Date:     09/18/11 16:46:06
Branch:   im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/0db2ee950691f472e16129df7c60cda547f1ede7

Changelog: 

Fix a bunch of tiny problems generating our doxygen documentation

Changes against parent d0d1612fb8120e1f47b7f9a119dce1d46c53e320

  patched  libpurple/ft.h
  patched  libpurple/notify.h
  patched  libpurple/prpl.c
  patched  libpurple/prpl.h
  patched  libpurple/request.c
  patched  libpurple/request.h
  patched  libpurple/roomlist.h
  patched  libpurple/util.h
  patched  libpurple/whiteboard.h
  patched  libpurple/xmlnode.h
  patched  pidgin/gtkutils.h
  patched  pidgin/gtkwebview.h

-------------- next part --------------
============================================================
--- libpurple/prpl.c	1f3856aaf74f2bff0066dc1101d3ace537c40a9e
+++ libpurple/prpl.c	1e96c85d1eec181d8de5a0154445b511c7990969
@@ -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 */
============================================================
--- libpurple/prpl.h	f6cd833266d7310b6ecc264cc56828195aa38393
+++ libpurple/prpl.h	6fca2ef4eeac9000d7a369c481848870e2bcd3aa
@@ -31,7 +31,10 @@ typedef struct _PurplePluginProtocolInfo
 #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;
 
 /**************************************************************************/
============================================================
--- pidgin/gtkutils.h	2e249909ea0f5927d7db6bce4430dac873b54ef5
+++ pidgin/gtkutils.h	985acb17aa9698ff4db57fafaa17fae52f19e234
@@ -928,12 +928,12 @@ GdkPixbuf *pidgin_pixbuf_new_from_file_a
 
 /**
  * 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
  */
============================================================
--- libpurple/ft.h	9acd827114eb58a374606a45a8cd182219925cc9
+++ libpurple/ft.h	a158b4b6945b672b033a6241416f8f9581deec2c
@@ -791,7 +791,7 @@ void purple_xfer_prepare_thumbnail(Purpl
  * 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
  */
============================================================
--- libpurple/util.h	1ecb84b638e883e1205affb8304309740b633a1a
+++ libpurple/util.h	0c7e2359f21148a6537d717efe4e8582ff84215b
@@ -36,9 +36,16 @@ typedef struct _PurpleUtilFetchUrlData P
   * 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 *(*PurpleInfoFieldFormatCal
 
 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;
============================================================
--- libpurple/notify.h	8594c96f730538e44c8e85ec27f74cd63f2861b6
+++ libpurple/notify.h	2202552eca8a9d951f3984068b36c668835cbad2
@@ -279,7 +279,7 @@ PurpleNotifySearchColumn *purple_notify_
 /**
  * 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 @@ void purple_notify_searchresult_column_s
 /**
  * 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.
  */
============================================================
--- libpurple/request.c	e44317d088aa83f84d8a85b31530e2bcde7af220
+++ libpurple/request.c	da818cd177aa782fd8c9c9bc5f7bcf92cee13b6e
@@ -42,9 +42,6 @@ typedef struct
 
 } PurpleRequestInfo;
 
-/**
- * A request field.
- */
 struct _PurpleRequestField
 {
 	PurpleRequestFieldType type;
============================================================
--- libpurple/request.h	d171f29c28cfb45e24f9a2bba8f164e9e728fada
+++ libpurple/request.h	27f58da773740312a15e76501c341cb29b24061c
@@ -30,7 +30,9 @@
 #include <glib-object.h>
 #include <glib.h>
 
-/** @copydoc _PurpleRequestField */
+/**
+ * A request field.
+ */
 typedef struct _PurpleRequestField PurpleRequestField;
 
 /**
@@ -321,7 +323,7 @@ gpointer purple_request_fields_get_ui_da
  * @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);
 
 /*@}*/
 
============================================================
--- libpurple/xmlnode.h	549855bb896a6d1ef06998c61f089d0adee65d6e
+++ libpurple/xmlnode.h	5908475d5f2b76bc27c23a0f926e513224d1b0c0
@@ -230,9 +230,11 @@ const char *xmlnode_get_namespace(const 
  * 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".
============================================================
--- libpurple/roomlist.h	a69b2d4a8867d75ae3f2d9eafa763c50b0c4290d
+++ libpurple/roomlist.h	64882aa3e70354ea78dae2d5fb9ef745535403bb
@@ -224,7 +224,7 @@ GList *purple_roomlist_get_fields(Purple
 /**
  * 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 @@ void purple_roomlist_set_proto_data(Purp
 /**
  * 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 @@ gpointer purple_roomlist_get_ui_data(Pur
  * 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);
 
============================================================
--- libpurple/whiteboard.h	5fa0d8d851ed890e0f70ea97b0d7bf23ce67b64b
+++ libpurple/whiteboard.h	49808031ef53bed03d0f42f67296df7bc49ac8cb
@@ -309,10 +309,10 @@ void purple_whiteboard_set_draw_list(Pur
  * 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.
  *
============================================================
--- pidgin/gtkwebview.h	32fe88aad9e13230fb22f63d99812537f81d8920
+++ pidgin/gtkwebview.h	108d5500d697ab29ae5321dd5dd652e542d0b1da
@@ -94,7 +94,7 @@ void gtk_webview_append_html(GtkWebView 
 
 /**
  * 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


More information about the Commits mailing list