← Back to branch summary

~sergiusens/unity-api/saucy

« back to all changes in this revision

Viewing changes to include/unity/api/Version.h.cmake

  • Committer: Michi Henning
  • Date: 2013-04-02 22:52:05 UTC
  • Revision ID: michi.henning@canonical.com-20130402225205-32w6dgrdurmnk6el
Fixed doxygen config to include generated headers.
Suppressed doxygen chatter on stdout during build.
Improved documentation for Version.cpp.

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/unity/api/Version.h.cmake
36
36
{
37
37
 
38
38
/**
39
 
\brief Class to obtain version information for the Scopes API at run time.
 
39
\brief Class to obtain version information for the Unity API at run time.
40
40
 
41
41
Version information is represented as
42
42
<i>&lt;<code>major</code>&gt;</i>.<i>&lt;<code>minor</code>&gt;</i>.<i>&lt;<code>micro</code>&gt;</i>.
59
59
{
60
60
public:
61
61
    /**
62
 
    \return The major version number.
 
62
    \brief Returns the major version number of the Unity API library.
63
63
    */
64
64
    static int major_version();
65
65
 
66
66
    /**
67
 
    \return The minor version number.
 
67
    \brief Returns the minor version number of the Unity API library.
68
68
    */
69
69
    static int minor_version();
70
70
 
71
71
    /**
72
 
    \return The micro version number.
 
72
    \brief Returns the micro version number of the Unity API library.
73
73
    */
74
74
    static int micro_version();
75
75
 
76
76
    /**
77
 
    \return The version string in the format
78
 
            <i>&lt;<code>major</code>&gt;</i>.<i>&lt;<code>minor</code>&gt;</i>.<i>&lt;<code>micro</code>&gt;</i>.
 
77
    \brief Returns the Unity API version as a string in the format
 
78
    <i>&lt;<code>major</code>&gt;</i>.<i>&lt;<code>minor</code>&gt;</i>.<i>&lt;<code>micro</code>&gt;</i>.
79
79
    */
80
80
    static const char* str();    // Returns "major.minor.micro"
81
81