stumpless::Version Class Reference

Describes this version of Stumpless. More...

#include <Version.hpp>

Public Member Functions
	Version (int major, int minor, int patch)
	Version (struct stumpless_version *equivalent)
	Version (struct stumpless_version equivalent)
int	Compare (Version &version)
	Compares this Version with another one according to semantic versioning rules.
std::string	ToString (void)

Static Public Member Functions
static Version	GetCurrent (void)

Public Attributes
struct stumpless_version	equivalent

Static Public Attributes
static const char *	CURRENT_VERSION

Detailed Description

Describes this version of Stumpless.

Constructor & Destructor Documentation

Version() [1/3]

stumpless::Version::Version	(	int	major,
		int	minor,
		int	patch )

Version() [2/3]

stumpless::Version::Version

(

struct stumpless_version *

equivalent

)

Version() [3/3]

stumpless::Version::Version

(

struct stumpless_version

equivalent

)

Member Function Documentation

Compare()

int stumpless::Version::Compare

(

Version &

version

)

Compares this Version with another one according to semantic versioning rules.

Available since release v2.0.0.

Parameters

version

The Version to compare this one against.

Returns

0 if these each represent the same version number, a negative value if this Version is lower (that is, older), and a postive value if this Version is higher. The magnitude of the return value will indicate the level that differed, 1 denoting a patch level difference, 10 a minor version number difference, and 100 a major version number difference.

GetCurrent()

static Version stumpless::Version::GetCurrent ( void )

static

ToString()

std::string stumpless::Version::ToString

(

void

)

Member Data Documentation

CURRENT_VERSION

const char* stumpless::Version::CURRENT_VERSION

static

equivalent

struct stumpless_version stumpless::Version::equivalent

---

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

• Version.hpp