Merge lp:~michihenning/unity-api/fix-version into lp:unity-api

[Michi Henning]

Removed Version class and hoisted version functions into unity::api namespace. Fixed doc accordingly.

Removed Version class and hoisted version functions into unity::api namespace. Fixed doc accordingly.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:52
http://jenkins.qa.ubuntu.com/job/unity-api-ci/52/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-armhf-ci/9
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-armhf-ci/9/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-i386-ci/10

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-api-ci/52/rebuild

review: Approve (continuous-integration)

[Jussi Pakkanen (jpakkane)]

Yes.

review: Approve

=== modified file 'include/unity/api/Version.h.in'
--- include/unity/api/Version.h.in	2013-05-16 11:48:42 +0000
+++ include/unity/api/Version.h.in	2013-06-06 01:08:29 +0000
@@ -31,14 +31,19 @@
 
 #define UNITY_API_VERSION_STRING "@UNITY_API_VERSION@"
 
+/**
+\brief Top-level namespace for all things Unity-related.
+*/
 namespace unity
 {
 
+/**
+\brief Top-level namespace for public functionality of the Unity API.
+*/
 namespace api
 {
 
-/**
-\brief Class to obtain version information for the Unity API at run time.
+/** @name Version information
 
 Version information is represented as
 <i>&lt;<code>major</code>&gt;</i>.<i>&lt;<code>minor</code>&gt;</i>.<i>&lt;<code>micro</code>&gt;</i>.
@@ -53,47 +58,51 @@
 Changes in the minor version indicate feature additions that are binary compatible.
 */
 
-// Version could be a namespace instead of a class, but that requires a lower-case name,
-// which is inconsistent with the remainder of the API.
-
-class UNITY_API Version
-{
-public:
-    /**
-    \brief Returns the major version number of the Unity API library.
-
-    The major version number is also available as the macro <code>UNITY_API_VERSION_MAJOR</code>.
-    */
-    static int major_version();
-
-    /**
-    \brief Returns the minor version number of the Unity API library.
-
-    The minor version number is also available as the macro <code>UNITY_API_VERSION_MINOR</code>.
-    */
-    static int minor_version();
-
-    /**
-    \brief Returns the micro version number of the Unity API library.
-
-    The micro version number is also available as the macro <code>UNITY_API_VERSION_MICRO</code>.
-    */
-    static int micro_version();
-
-    /**
-    \brief Returns the Unity API version as a string in the format
-    <i>&lt;<code>major</code>&gt;</i>.<i>&lt;<code>minor</code>&gt;</i>.<i>&lt;<code>micro</code>&gt;</i>.
-
-    The version string is also available as the macro <code>UNITY_API_VERSION_STRING</code>.
-    */
-    static const char* str();    // Returns "major.minor.micro"
-
-    // TODO: Add methods to report compiler version and compiler flags
-
-private:
-    Version() = delete;
-    ~Version() = delete;
-};
+/**
+\brief Returns the major version number of the Unity API library.
+
+The major version number is also available as the macro <code>UNITY_API_VERSION_MAJOR</code>.
+*/
+
+/// @cond
+UNITY_API
+/// @endcond
+int major_version();
+
+/**
+\brief Returns the minor version number of the Unity API library.
+
+The minor version number is also available as the macro <code>UNITY_API_VERSION_MINOR</code>.
+*/
+/// @cond
+UNITY_API
+/// @endcond
+int minor_version();
+
+/**
+\brief Returns the micro version number of the Unity API library.
+
+The micro version number is also available as the macro <code>UNITY_API_VERSION_MICRO</code>.
+*/
+/// @cond
+UNITY_API
+/// @endcond
+int micro_version();
+
+/**
+\brief Returns the Unity API version as a string in the format
+<i>&lt;<code>major</code>&gt;</i>.<i>&lt;<code>minor</code>&gt;</i>.<i>&lt;<code>micro</code>&gt;</i>.
+
+The version string is also available as the macro <code>UNITY_API_VERSION_STRING</code>.
+*/
+/// @cond
+UNITY_API
+/// @endcond
+const char* str();    // Returns "major.minor.micro"
+
+/// }@
+
+// TODO: Add methods to report compiler version and compiler flags
 
 } // namespace api
 

=== modified file 'src/unity/api/Version.cpp'
--- src/unity/api/Version.cpp	2013-03-14 12:25:53 +0000
+++ src/unity/api/Version.cpp	2013-06-06 01:08:29 +0000
@@ -27,28 +27,24 @@
 {
 
 int
-Version::
 major_version()
 {
     return UNITY_API_VERSION_MAJOR;
 }
 
 int
-Version::
 minor_version()
 {
     return UNITY_API_VERSION_MINOR;
 }
 
 int
-Version::
 micro_version()
 {
     return UNITY_API_VERSION_MICRO;
 }
 
 char const*
-Version::
 str()
 {
     return UNITY_API_VERSION_STRING;

=== modified file 'test/gtest/unity/api/Version/Version_test.cpp'
--- test/gtest/unity/api/Version/Version_test.cpp	2013-03-14 12:25:53 +0000
+++ test/gtest/unity/api/Version/Version_test.cpp	2013-06-06 01:08:29 +0000
@@ -24,8 +24,8 @@
 
 TEST(Version, basic)
 {
-    EXPECT_EQ(Version::major_version(), UNITY_API_VERSION_MAJOR);
-    EXPECT_EQ(Version::minor_version(), UNITY_API_VERSION_MINOR);
-    EXPECT_EQ(Version::micro_version(), UNITY_API_VERSION_MICRO);
-    EXPECT_STREQ(Version::str(), UNITY_API_VERSION_STRING);
+    EXPECT_EQ(major_version(), UNITY_API_VERSION_MAJOR);
+    EXPECT_EQ(minor_version(), UNITY_API_VERSION_MINOR);
+    EXPECT_EQ(micro_version(), UNITY_API_VERSION_MICRO);
+    EXPECT_STREQ(str(), UNITY_API_VERSION_STRING);
 }