Mercurial > ldforge / changeset

--- a/src/Format.h	Wed Mar 05 18:31:22 2014 +0200
+++ b/src/Format.h	Wed Mar 05 18:42:26 2014 +0200
@@ -20,6 +20,9 @@
 #include <QString>
 #include "Types.h"
 
+//! \file Format.h
+//! Contains string formatting-related functions and classes.
+
 //!
 //! Converts a given value into a string that can be retrieved with text().
 //! Used as the argument type to the formatting functions, hence its name.
@@ -80,7 +83,7 @@
 }
 
 //!
-//! Overload of \c formatHelper with no template args
+//! Overload of \c formatHelper() with no template args
 //!
 static void formatHelper (QString& str) __attribute__ ((unused));
 static void formatHelper (QString& str)
@@ -89,7 +92,12 @@
 }
 
 //!
-//! Format the message with the given args
+//! @brief Format the message with the given args.
+//!
+//! The formatting ultimately uses QString's arg() method to actually format
+//! the args so the format string should be prepared accordingly, with %1
+//! referring to the first arg, %2 to the second, etc.
+//!
 //! \param fmtstr The string to format
 //! \param args The args to format with
 //! \return The formatted string

--- a/src/Version.h	Wed Mar 05 18:31:22 2014 +0200
+++ b/src/Version.h	Wed Mar 05 18:42:26 2014 +0200
@@ -16,15 +16,33 @@
  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+//! \file Version.h
+//! Contains macros related to application name and version.
+
 #pragma once
+
+//! The application name.
 #define APPNAME			"LDForge"
+
+//! The unix-style name of the application. used in filenames
 #define UNIXNAME		"ldforge"
+
+//! The major version number.
 #define VERSION_MAJOR	0
-#define VERSION_MINOR	2
-#define VERSION_PATCH	999
+
+//! The minor version number.
+#define VERSION_MINOR	3
+
+//! The patch level version number.
+#define VERSION_PATCH	0
+
+//! The build ID, use either BUILD_INTERNAL or BUILD_RELEASE
 #define BUILD_ID		BUILD_INTERNAL
 
+//! The build code for internal builds
 #define BUILD_INTERNAL	0
+
+//! The build code for release builds.
 #define BUILD_RELEASE	1
 
 // =============================================