[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    playground/libs/kgllib
From:       Rivo Laks <rivolaks () hot ! ee>
Date:       2008-08-31 10:18:07
Message-ID: 1220177887.439904.25736.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 855220 by rivol:

Document version functions and make doxygen read kgllib_version.h.cmake

 M  +1 -1      Doxyfile  
 M  +45 -0     core/kgllib/kgllib_version.h.cmake  


--- trunk/playground/libs/kgllib/Doxyfile #855219:855220
@@ -459,7 +459,7 @@
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = core/kgllib extras/kgllib Mainpage.dox
+INPUT                  = core/kgllib extras/kgllib Mainpage.dox core/kgllib/kgllib_version.h.cmake
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
--- trunk/playground/libs/kgllib/core/kgllib/kgllib_version.h.cmake #855219:855220
@@ -20,31 +20,76 @@
 
 #include "kgllib_export.h"
 
+/**
+ * @file kgllib_version.h
+ **/
 
+/**
+ * Major number of KGLLib's compile-time version
+ **/
 #define KGLLIB_VERSION_MAJOR @KGLLIB_VERSION_MAJOR@
+/**
+ * Minor number of KGLLib's compile-time version
+ **/
 #define KGLLIB_VERSION_MINOR @KGLLIB_VERSION_MINOR@
+/**
+ * Release number of KGLLib's compile-time version
+ **/
 #define KGLLIB_VERSION_RELEASE @KGLLIB_VERSION_RELEASE@
 
+/**
+ * Compile-time version of KGLLib, as a string
+ **/
 #define KGLLIB_VERSION_STRING \
         "@KGLLIB_VERSION_MAJOR@.@KGLLIB_VERSION_MINOR@.@KGLLIB_VERSION_RELEASE@"
 
+/**
+ * Macro to encode major, minor and release number into a version number.
+ **/
 #define KGLLIB_MAKE_VERSION(a, b, c) (((a) << 16) | ((b) << 8) | (c))
 
+/**
+ * Compile-time version of KGLLib, encoded with KGLLIB_MAKE_VERSION macro
+ **/
 #define KGLLIB_VERSION \
         KGLLIB_MAKE_VERSION(KGLLIB_VERSION_MAJOR, KGLLIB_VERSION_MINOR, KGLLIB_VERSION_RELEASE)
 
+/**
+ * Checks whether KGLLib's compile-time version is equal to or higher than the
+ *  given version.
+ **/
 #define KGLLIB_IS_VERSION(a, b, c) (KGLLIB_VERSION >= KGLLIB_MAKE_VERSION(a, b, c))
 
 namespace KGLLib
 {
+/**
+ * Returns the encoded runtime version of KGLLib.
+ *
+ * The returned value is encoded according to the KGLLIB_MAKE_VERSION macro.
+ **/
 KGLLIB_EXPORT unsigned int version();
 
+/**
+ * Returns the major number of KGLLib's version, e.g. 0 for 0.1.2
+ **/
 KGLLIB_EXPORT unsigned int versionMajor();
+/**
+ * Returns the minor number of KGLLib's version, e.g. 1 for 0.1.2
+ **/
 KGLLIB_EXPORT unsigned int versionMinor();
+/**
+ * Returns the release number of KGLLib's version, e.g. 2 for 0.1.2
+ **/
 KGLLIB_EXPORT unsigned int versionRelease();
 
+/**
+ * Checks if KGLLib's version is at least the given version.
+ **/
 KGLLIB_EXPORT bool isVersion(unsigned int a, unsigned int b, unsigned int c);
 
+/**
+ * Returns KGLLib's version as a string, e.g. "0.1.2"
+ **/
 KGLLIB_EXPORT const char* versionString();
 }
 
[prev in list] [next in list] [prev in thread] [next in thread]