changeset 11035:11e465b55fe6

[gaim-migrate @ 12922] A host of doxygen tweaks. There's a few more left, not sure how to fix them at the moment... committer: Tailor Script <tailor@pidgin.im>
author Gary Kramlich <grim@reaperworld.com>
date Tue, 28 Jun 2005 20:36:20 +0000
parents ba506d2e6a8e
children b6070e971ceb
files src/conversation.h src/core.h src/gtkdialogs.h src/gtkgaim.h src/log.h src/mime.h src/prpl.h src/status.h
diffstat 8 files changed, 10 insertions(+), 17 deletions(-) [+]
line wrap: on
line diff
--- a/src/conversation.h	Tue Jun 28 20:20:18 2005 +0000
+++ b/src/conversation.h	Tue Jun 28 20:36:20 2005 +0000
@@ -412,10 +412,8 @@
 /**
  * Switches the active conversation to the one at the specified index.
  *
- * If @a index is out of range, this does nothing.
- *
- * @param win   The window.
- * @param index The new index.
+ * @param win  The window.
+ * @param conv The converstion to switch to.
  */
 void gaim_conv_window_switch_conversation(GaimConvWindow *win,
                                           GaimConversation *conv);
--- a/src/core.h	Tue Jun 28 20:20:18 2005 +0000
+++ b/src/core.h	Tue Jun 28 20:36:20 2005 +0000
@@ -1,5 +1,4 @@
 /**
- * @file core.h Gaim Core API
  * @defgroup core Gaim Core
  *
  * gaim
--- a/src/gtkdialogs.h	Tue Jun 28 20:20:18 2005 +0000
+++ b/src/gtkdialogs.h	Tue Jun 28 20:36:20 2005 +0000
@@ -1,5 +1,4 @@
 /**
- * @file gtkdialogs.h Assorted GTK+ dialogs
  * @defgroup gtkui GTK+ User Interface
  *
  * gaim
--- a/src/gtkgaim.h	Tue Jun 28 20:20:18 2005 +0000
+++ b/src/gtkgaim.h	Tue Jun 28 20:36:20 2005 +0000
@@ -42,7 +42,7 @@
 # define GAIM_ALERT_TITLE "Gaim"
 #endif
 
-/*
+/**
  * This is backwards-compatibility code for older versions of GTK+ (< 2.4.x)
  * It defines the new wrap behavior (unknown in earlier versions)
  * as the old (slightly buggy) wrap behavior.
--- a/src/log.h	Tue Jun 28 20:20:18 2005 +0000
+++ b/src/log.h	Tue Jun 28 20:36:20 2005 +0000
@@ -56,7 +56,6 @@
  * This struct gets filled out and is included in the GaimLog.  It contains everything
  * needed to write and read from logs.
  */
-/*@{*/
 struct _GaimLogLogger {
 	char *name;               /**< The logger's name */
 	char *id;                 /**< an identifier to refer to this logger */
--- a/src/mime.h	Tue Jun 28 20:20:18 2005 +0000
+++ b/src/mime.h	Tue Jun 28 20:36:20 2005 +0000
@@ -156,7 +156,7 @@
 
 /** Set or replace the value of a specific field in the header of a
     document
-    @param doc    the MIME document
+    @param part   the part of the MIME document
     @param field  case-insensitive field name
     @param value  value to associate with the indicated header field,
                   of NULL to remove the field
@@ -179,7 +179,8 @@
     return NULL.
 
     @param part the MIME documemt part
-    @param 
+    @param data Buffer for the data
+	@param len  The length of the buffer
 */
 void gaim_mime_part_get_data_decoded(GaimMimePart *part,
 				     char **data, gsize *len);
--- a/src/prpl.h	Tue Jun 28 20:20:18 2005 +0000
+++ b/src/prpl.h	Tue Jun 28 20:36:20 2005 +0000
@@ -74,7 +74,7 @@
 } GaimBuddyIconSpec;
 
 /**
- * This #define exists just to make it easier to fill out the buddy icon
+ * This \#define exists just to make it easier to fill out the buddy icon
  * field in the prpl info struct for protocols that couldn't care less.
  */
 #define NO_BUDDY_ICONS {NULL, 0, 0, 0, 0, 0}
--- a/src/status.h	Tue Jun 28 20:20:18 2005 +0000
+++ b/src/status.h	Tue Jun 28 20:36:20 2005 +0000
@@ -1,7 +1,4 @@
-/**
- * @file status.h Status API
- * @ingroup core
- *
+/*
  * gaim
  *
  * Gaim is the legal property of its developers, whose names are too numerous
@@ -26,8 +23,8 @@
 #define _GAIM_STATUS_H_
 
 /**
- * TODO: Someone figure out if we need to do something to get
- *       this in the Doxygen generated docs.
+ * @file status.h Status API
+ * @ingroup core
  *
  * A brief explanation of the status API:
  *