changeset 22870:3d7e9eff04d0

Assorted cleanups, mostly to the Doxygen comments. I added a few missing @since tags.
author Richard Laager <rlaager@wiktel.com>
date Sun, 11 May 2008 05:08:08 +0000
parents cf2ac6f0758a
children 24dfef623410
files finch/gntlog.h libpurple/blist.h libpurple/conversation.h libpurple/eventloop.h libpurple/prpl.h libpurple/util.h pidgin/gtkthemes.h
diffstat 7 files changed, 16 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/finch/gntlog.h	Sun May 11 05:04:07 2008 +0000
+++ b/finch/gntlog.h	Sun May 11 05:08:08 2008 +0000
@@ -1,7 +1,6 @@
 /**
  * @file gntlog.h GNT Log viewer
  * @ingroup finch
- * @see @ref gntlog-signals
  */
 
 /* finch
--- a/libpurple/blist.h	Sun May 11 05:04:07 2008 +0000
+++ b/libpurple/blist.h	Sun May 11 05:08:08 2008 +0000
@@ -957,6 +957,7 @@
  * @param node The node.
  *
  * @return The type of the node.
+ * @since 2.1.0
  */
 PurpleBlistNodeType purple_blist_node_get_type(PurpleBlistNode *node);
 
--- a/libpurple/conversation.h	Sun May 11 05:04:07 2008 +0000
+++ b/libpurple/conversation.h	Sun May 11 05:08:08 2008 +0000
@@ -119,7 +119,7 @@
 	PURPLE_MESSAGE_IMAGES      = 0x1000, /**< Message contains images  */
 	PURPLE_MESSAGE_NOTIFY      = 0x2000, /**< Message is a notification */
 	PURPLE_MESSAGE_NO_LINKIFY  = 0x4000, /**< Message should not be auto-
-										   linkified */
+										   linkified @since 2.1.0 */
 	PURPLE_MESSAGE_INVISIBLE   = 0x8000, /**< Message should not be displayed */
 } PurpleMessageFlags;
 
--- a/libpurple/eventloop.h	Sun May 11 05:04:07 2008 +0000
+++ b/libpurple/eventloop.h	Sun May 11 05:08:08 2008 +0000
@@ -141,6 +141,7 @@
 	 * #timeout_add.
 	 *
 	 * @see purple_timeout_add_seconds()
+	 * @since 2.1.0
 	 **/
 	guint (*timeout_add_seconds)(guint interval, GSourceFunc function,
 	                             gpointer data);
--- a/libpurple/prpl.h	Sun May 11 05:04:07 2008 +0000
+++ b/libpurple/prpl.h	Sun May 11 05:08:08 2008 +0000
@@ -177,6 +177,7 @@
 	/**
 	 * Indicates that slash commands are native to this protocol.
 	 * Used as a hint that unknown commands should not be sent as messages.
+	 * @since 2.1.0
 	 */
 	OPT_PROTO_SLASH_COMMANDS_NATIVE = 0x00000400,
 
--- a/libpurple/util.h	Sun May 11 05:04:07 2008 +0000
+++ b/libpurple/util.h	Sun May 11 05:08:08 2008 +0000
@@ -1090,7 +1090,7 @@
 /**
  * Checks if the given IP address is a syntactically valid IPv4 address.
  *
- * @param address The IP address to validate.
+ * @param ip The IP address to validate.
  *
  * @return True if the IP address is syntactically correct.
  */
--- a/pidgin/gtkthemes.h	Sun May 11 05:04:07 2008 +0000
+++ b/pidgin/gtkthemes.h	Sun May 11 05:08:08 2008 +0000
@@ -46,10 +46,20 @@
 extern GSList *smiley_themes;
 
 void pidgin_themes_init(void);
+
 gboolean pidgin_themes_smileys_disabled(void);
+
 void pidgin_themes_smiley_themeize(GtkWidget *);
+
 void pidgin_themes_smiley_theme_probe(void);
+
 void pidgin_themes_load_smiley_theme(const char *file, gboolean load);
+
+/**
+ * @since 2.1.0
+ */
 void pidgin_themes_remove_smiley_theme(const char *file);
+
 GSList *pidgin_themes_get_proto_smileys(const char *id);
-#endif /* _PIDGINDIALOGS_H_ */
+
+#endif /* _PIDGINTHEMES_H_ */