Mercurial > pidgin
changeset 25488:bb43dea90623
Document the PURPLE_MAJOR_VERSION, PURPLE_MINOR_VERSION, and
PURPLE_MICRO_VERSION defines and the PurplePrefType enums to silence some more
doxygen complaining.
| author | Etan Reisner <pidgin@unreliablesource.net> |
|---|---|
| date | Wed, 18 Feb 2009 04:23:31 +0000 |
| parents | 96af49d5758d |
| children | b93f3d152de6 |
| files | libpurple/prefs.h libpurple/version.h.in |
| diffstat | 2 files changed, 11 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/libpurple/prefs.h Wed Feb 18 04:21:07 2009 +0000 +++ b/libpurple/prefs.h Wed Feb 18 04:23:31 2009 +0000 @@ -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;
--- a/libpurple/version.h.in Wed Feb 18 04:21:07 2009 +0000 +++ b/libpurple/version.h.in Wed Feb 18 04:23:31 2009 +0000 @@ -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 && \