Author: wyoung
Date: Fri Jan 12 10:40:08 2007
New Revision: 1371
URL: http://svn.gna.org/viewcvs/mysqlpp?rev=1371&view=rev
Log:
Added some more Doxygen documentation
Modified:
trunk/lib/mysql++.h.in
Modified: trunk/lib/mysql++.h.in
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/mysql%2B%2B.h.in?rev=1371&r1=1370&r2=1371&view=diff
==============================================================================
--- trunk/lib/mysql++.h.in (original)
+++ trunk/lib/mysql++.h.in Fri Jan 12 10:40:08 2007
@@ -38,13 +38,18 @@
#if !defined(MYSQLPP_MYSQLPP_H)
#define MYSQLPP_MYSQLPP_H
-// Encode MySQL++ library version number. MYSQLPP_VERSION macro takes
-// major, minor and bugfix numbers (e.g. 1, 2, and 3) and encodes them
-// like 0x010203. MYSQLPP_LIB_VERSION is the current library version
-// in the same scheme, so between these two macros you can create
-// conditional code based on the MySQL++ library version.
+/// \brief Encode MySQL++ library version number.
+///
+/// This macro takes major, minor and bugfix numbers (e.g. 1, 2, and 3)
+/// and encodes them like 0x010203. MYSQLPP_LIB_VERSION is the current
+/// library version in the same scheme, so between these two macros you
+/// can create conditional code based on the MySQL++ library version.
#define MYSQLPP_VERSION(major, minor, bugfix) \
(((major) << 16) | ((minor) << 8) | (bugfix))
+
+/// \brief Get the current MySQL++ library version number
+///
+/// Version number is encoded by MYSQLPP_VERSION macro.
#define MYSQLPP_LIB_VERSION MYSQLPP_VERSION(@MYSQLPP_VERSION_MAJOR@,
@MYSQLPP_VERSION_MINOR@, @MYSQLPP_VERSION_BUGFIX@)
// This #include order gives the fewest redundancies in the #include
_______________________________________________
Mysqlpp-commits mailing list
[email protected]
https://mail.gna.org/listinfo/mysqlpp-commits
