pidgin: c08bb227: Re-arrange these doxygen comments. For ...

markdoliner at pidgin.im markdoliner at pidgin.im
Sun Sep 18 16:20:47 EDT 2011


----------------------------------------------------------------------
Revision: c08bb2274d5d8fb1f49e55a09f2cbffe02bf24ef
Parent:   1e0156a0321eeed4f351e9577ef964cde3343759
Author:   markdoliner at pidgin.im
Date:     09/18/11 16:18:33
Branch:   im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/c08bb2274d5d8fb1f49e55a09f2cbffe02bf24ef

Changelog: 

Re-arrange these doxygen comments.  For comments longer than a few words,
putting the comment before the variable like this seems cleaner than trying
to cram it on the same line as the variable and using lots of crazy
indentation.  Anyone have a strong opinion either way?

Changes against parent 1e0156a0321eeed4f351e9577ef964cde3343759

  patched  libpurple/conversation.h

-------------- next part --------------
============================================================
--- libpurple/conversation.h	7458fc4790d5e03ff879de2381a11b407b3e16d3
+++ libpurple/conversation.h	60e56341641057ac8b5602c75adc4e062cae321a
@@ -291,25 +291,39 @@ struct _PurpleConvChatBuddy
  */
 struct _PurpleConvChatBuddy
 {
-	char *name;                      /**< The chat participant's name in the chat. */
-	char *alias;                     /**< The chat participant's alias, if known;
-	                                  *   @a NULL otherwise.
-	                                  */
-	char *alias_key;                 /**< A string by which this buddy will be sorted,
-	                                  *   or @c NULL if the buddy should be sorted by
-	                                  *   its @c name.  (This is currently always @c
-	                                  *   NULL.)
-	                                  */
-	gboolean buddy;                  /**< @a TRUE if this chat participant is on the
-	                                  *   buddy list; @a FALSE otherwise.
-	                                  */
-	PurpleConvChatBuddyFlags flags;  /**< A bitwise OR of flags for this participant,
-	                                  *   such as whether they are a channel operator.
-	                                  */
-	GHashTable *attributes;          /**< A hash table of attributes about the user, such as
-                                    *   real name, user at host, etc.
-                                    */
-	gpointer ui_data;                /** < The UI can put whatever it wants here. */
+	/** The chat participant's name in the chat. */
+	char *name;
+
+	/** The chat participant's alias, if known; @a NULL otherwise. */
+	char *alias;
+
+	/**
+	 * A string by which this buddy will be sorted, or @c NULL if the
+	 * buddy should be sorted by its @c name.  (This is currently always
+	 * @c NULL.
+	 */
+	char *alias_key;
+
+	/**
+	 * @a TRUE if this chat participant is on the buddy list;
+	 * @a FALSE otherwise.
+	 */
+	gboolean buddy;
+
+	/**
+	 * A bitwise OR of flags for this participant, such as whether they
+	 * are a channel operator.
+	 */
+	PurpleConvChatBuddyFlags flags;
+
+	/**
+	 * A hash table of attributes about the user, such as real name,
+	 * user at host, etc.
+	 */
+	GHashTable *attributes;
+
+	/** The UI can put whatever it wants here. */
+	gpointer ui_data;
 };
 
 /**


More information about the Commits mailing list