Mercurial > pidgin

--- a/libpurple/blist.h	Sun Aug 30 03:56:32 2009 +0000
+++ b/libpurple/blist.h	Sun Aug 30 04:10:22 2009 +0000
@@ -223,7 +223,7 @@
 	 * be set to a fallback function that saves data to blist.xml like in
 	 * previous libpurple versions.
 	 *
-	 * @attrib node    The node which has been modified.
+	 * @param node    The node which has been modified.
 	 *
 	 * @since 2.6.0.
 	 */
@@ -238,7 +238,7 @@
 	 * be set to a fallback function that saves data to blist.xml like in
 	 * previous libpurple versions.
 	 *
-	 * @attrib node  The node which has been modified.
+	 * @param node  The node which has been modified.
 	 * @since 2.6.0.
 	 */
 	void (*remove_node)(PurpleBlistNode *node);
@@ -252,7 +252,7 @@
 	 * be set to a fallback function that saves data to blist.xml like in
 	 * previous libpurple versions.
 	 *
-	 * @attrib account  The account whose data to save. If NULL, save all data
+	 * @param account  The account whose data to save. If NULL, save all data
 	 *                  for all accounts.
 	 * @since 2.6.0.
 	 */
--- a/libpurple/conversation.h	Sun Aug 30 03:56:32 2009 +0000
+++ b/libpurple/conversation.h	Sun Aug 30 04:10:22 2009 +0000
@@ -1308,7 +1308,7 @@
  * @param user     The user to invite to the chat.
  * @param message  The message to send with the invitation.
  * @param confirm  Prompt before sending the invitation. The user is always
- *                 prompted if either #user or #message is @c NULL.
+ *                 prompted if either \a user or \a message is @c NULL.
  *
  * @since 2.6.0
  */
--- a/libpurple/core.h	Sun Aug 30 03:56:32 2009 +0000
+++ b/libpurple/core.h	Sun Aug 30 04:10:22 2009 +0000
@@ -24,6 +24,16 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  */
+
+/*! @mainpage Pidgin/Finch/libpurple API Documentation
+ *
+ * <a href="group__core.html">libpurple</a> is intended to be the core of an IM
+ * program.  <a href="group__pidgin.html">Pidgin</a> is a GTK+ frontend
+ * to libpurple, and <a href="group__finch.html">Finch</a> is an ncurses
+ * frontend built using <a href="group__gnt.html">libgnt</a>
+ * (GLib Ncurses Toolkit).
+ */
+
 #ifndef _PURPLE_CORE_H_
 #define _PURPLE_CORE_H_
--- a/libpurple/dnssrv.h	Sun Aug 30 03:56:32 2009 +0000
+++ b/libpurple/dnssrv.h	Sun Aug 30 04:10:22 2009 +0000
@@ -98,11 +98,11 @@
 /**
  * Get the value of the current TXT record.
  *
- * @param resp  The TXT response record
+ * @param response  The TXT response record
  * @returns The value of the current TXT record.
  * @since 2.6.0
  */
-const gchar *purple_txt_response_get_content(PurpleTxtResponse *resp);
+const gchar *purple_txt_response_get_content(PurpleTxtResponse *response);

 /**
  * Destroy a TXT DNS response object.
@@ -110,7 +110,7 @@
  * @param response The PurpleTxtResponse to destroy.
  * @since 2.6.0
  */
-void purple_txt_response_destroy(PurpleTxtResponse *resp);
+void purple_txt_response_destroy(PurpleTxtResponse *response);

 #ifdef __cplusplus
 }
--- a/libpurple/smiley.h	Sun Aug 30 03:56:32 2009 +0000
+++ b/libpurple/smiley.h	Sun Aug 30 04:10:22 2009 +0000
@@ -192,7 +192,7 @@
  * @param smiley  The custom smiley.
  *
  * @return A full path to the file, or @c NULL under various conditions.
- *         The caller should use #g_free to free the returned string.
+ *         The caller should use g_free to free the returned string.
  */
 char *purple_smiley_get_full_path(PurpleSmiley *smiley);
--- a/libpurple/status.h	Sun Aug 30 03:56:32 2009 +0000
+++ b/libpurple/status.h	Sun Aug 30 04:10:22 2009 +0000
@@ -72,6 +72,16 @@
  * for the current PurpleSession.
  */

+/**
+ * PurpleStatusType's are created by each PRPL.  They outline the
+ * available statuses of the protocol.  AIM, for example, supports
+ * an available state with an optional available message, an away
+ * state with a mandatory message, and an invisible state (which is
+ * technically "independent" of the other two, but we'll get into
+ * that later).  PurpleStatusTypes are very permanent.  They are
+ * hardcoded in each PRPL and will not change often.  And because
+ * they are hardcoded, they do not need to be saved to any XML file.
+ */
 typedef struct _PurpleStatusType      PurpleStatusType;
 typedef struct _PurpleStatusAttr      PurpleStatusAttr;
 typedef struct _PurplePresence        PurplePresence;
--- a/libpurple/util.h	Sun Aug 30 03:56:32 2009 +0000
+++ b/libpurple/util.h	Sun Aug 30 04:10:22 2009 +0000
@@ -31,8 +31,14 @@

 #include <stdio.h>

+/**
+  * An opaque structure representing a URL request. Can be used to cancel
+  * the request.
+  */
 typedef struct _PurpleUtilFetchUrlData PurpleUtilFetchUrlData;
+/** @copydoc _PurpleMenuAction */
 typedef struct _PurpleMenuAction PurpleMenuAction;
+/** @copydoc _PurpleKeyValuePair */
 typedef struct _PurpleKeyValuePair PurpleKeyValuePair;

 #include "account.h"
@@ -107,7 +113,7 @@
  * @param album     The album of the song, can be @c NULL.
  * @param unused    Currently unused, must be @c NULL.
  *
- * @return   The formatted string. The caller must #g_free the returned string.
+ * @return   The formatted string. The caller must g_free the returned string.
  * @since 2.4.0
  */
 char * purple_util_format_song_info(const char *title, const char *artist,
--- a/pidgin/gtkimhtml.h	Sun Aug 30 03:56:32 2009 +0000
+++ b/pidgin/gtkimhtml.h	Sun Aug 30 04:10:22 2009 +0000
@@ -188,8 +188,8 @@
 	GSList *anchors;
 	GtkIMHtmlSmileyFlags flags;
 	GtkIMHtml *imhtml;
-	gpointer data;       /** @Since 2.6.0 */
-	gsize datasize;      /** @Since 2.6.0 */
+	gpointer data;       /** @since 2.6.0 */
+	gsize datasize;      /** @since 2.6.0 */
 };

 struct _GtkIMHtmlScalable {
@@ -906,7 +906,7 @@
  *                      @c TRUE if the request for context menu was processed
  *                      successfully, @c FALSE otherwise.
  *
- * @return  @c TRUE if the protocol was successfully registered (or unregistered, when #activate is @c NULL)
+ * @return  @c TRUE if the protocol was successfully registered (or unregistered, when \a activate is @c NULL)
  *
  * @since 2.6.0
  */