pidgin: cee63f93: Document the PURPLE_MAJOR_VERSION, PURPL...

deryni at pidgin.im deryni at pidgin.im
Wed Feb 18 22:45:39 EST 2009


-----------------------------------------------------------------
Revision: cee63f93d8c1fdcf74c596d5958b744aa0638042
Ancestor: 85b04aa0f4e03f9656f98e492561a8d433bb9ffa
Author: deryni at pidgin.im
Date: 2009-02-18T04:23:31
Branch: im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/cee63f93d8c1fdcf74c596d5958b744aa0638042

Modified files:
        libpurple/prefs.h libpurple/version.h.in

ChangeLog: 

Document the PURPLE_MAJOR_VERSION, PURPLE_MINOR_VERSION, and
PURPLE_MICRO_VERSION defines and the PurplePrefType enums to silence some more
doxygen complaining.

-------------- next part --------------
============================================================
--- libpurple/prefs.h	059e0c6b8e352a3b486619b7a93aebcfe7de6752
+++ libpurple/prefs.h	4a0a1b5adbbeda07bfb16465fcd2057868e9536e
@@ -30,17 +30,17 @@
 #include <glib.h>
 
 /**
- * Pref data types.
+ * Preference data types.
  */
 typedef enum _PurplePrefType
 {
-	PURPLE_PREF_NONE,
-	PURPLE_PREF_BOOLEAN,
-	PURPLE_PREF_INT,
-	PURPLE_PREF_STRING,
-	PURPLE_PREF_STRING_LIST,
-	PURPLE_PREF_PATH,
-	PURPLE_PREF_PATH_LIST
+	PURPLE_PREF_NONE,        /**< No type.         */
+	PURPLE_PREF_BOOLEAN,     /**< Boolean.         */
+	PURPLE_PREF_INT,         /**< Integer.         */
+	PURPLE_PREF_STRING,      /**< String.          */
+	PURPLE_PREF_STRING_LIST, /**< List of strings. */
+	PURPLE_PREF_PATH,        /**< Path.            */
+	PURPLE_PREF_PATH_LIST    /**< List of paths.   */
 
 } PurplePrefType;
 
============================================================
--- libpurple/version.h.in	4a730e580df7c0382ed6f7c24aa85d55f67537b8
+++ libpurple/version.h.in	7efcc324b64b08cc6b78b4f7bdaea90cef660a8c
@@ -24,8 +24,11 @@
 #ifndef _PURPLE_VERSION_H_
 #define _PURPLE_VERSION_H_
 
+/** The major version of the running libpurple. */
 #define PURPLE_MAJOR_VERSION (@PURPLE_MAJOR_VERSION@)
+/** The minor version of the running libpurple. */
 #define PURPLE_MINOR_VERSION (@PURPLE_MINOR_VERSION@)
+/** The micro version of the running libpurple. */
 #define PURPLE_MICRO_VERSION (@PURPLE_MICRO_VERSION@)
 
 #define PURPLE_VERSION_CHECK(x,y,z) ((x) == PURPLE_MAJOR_VERSION && \


More information about the Commits mailing list