playrho::Version Struct Reference

Version numbering scheme. More...

#include <Version.hpp>

Collaboration diagram for playrho::Version:

Public Types
using	Revnum = std::int32_t
	Revision number type.

Public Attributes
Revnum	major
	Major version number. More...
Revnum	minor
	Minor version number. More...
Revnum	revision
	Revision version number. More...

Detailed Description

Version numbering scheme.

Version class for numbering the PlayRho library releases. Follows Semantic Versioning 2.0.0.

See also

https://en.wikipedia.org/wiki/Software_versioning

https://semver.org

Member Data Documentation

major

Revnum playrho::Version::major

Major version number.

Changed to represent significant changes. Specifically this field is incremented when backwards incompatible changes are introduced to the public API. The minor and revision fields are reset to 0 when this field is incremented.

Note

Started at 0.

Referenced by playrho::operator==().

minor

Revnum playrho::Version::minor

Minor version number.

Changed to represent incremental changes. Specifically this field is incremented when new, backwards compatible functionality is introduced to the public API, or when any public API functionality is marked as deprecated.

Referenced by playrho::operator==().

revision

Revnum playrho::Version::revision

Revision version number.

Changed to represent bug fixes.

Note

Also known as the patch version.

Referenced by playrho::operator==().

---

The documentation for this struct was generated from the following file:

• Version.hpp