NDEVR
API Documentation
IncrementVersion

Increments the version number in a module's header file, supporting major, minor, and patch version bumps. More...

Collaboration diagram for IncrementVersion:
[legend]

Public Member Functions

String fileName () const
 Returns the file name of the module header containing the version.
String incrementString (const String &line) const
 Processes a single line and increments the version number if found.
bool incrementVersion () const
 Increments the version in the default module header file.
bool incrementVersion (File &file) const
 Increments the version in the specified file.

Public Attributes

bool increment_major = false
 Whether to increment the major version number.
bool increment_minor = false
 Whether to increment the minor version number.
LogPtr log = nullptr
 Log for status messages.
String project_name
 The module project name whose version is incremented.
File source_directory
 The root source directory containing the module.

Detailed Description

Increments the version number in a module's header file, supporting major, minor, and patch version bumps.

Definition at line 11 of file IncrementVersion.h.

Member Function Documentation

◆ fileName()

String IncrementVersion::fileName ( ) const

Returns the file name of the module header containing the version.

Returns
The version header file name.

◆ incrementString()

String IncrementVersion::incrementString ( const String & line) const

Processes a single line and increments the version number if found.

Parameters
[in]lineThe line to process.
Returns
The modified line with incremented version, or the original line.

◆ incrementVersion() [1/2]

bool IncrementVersion::incrementVersion ( ) const

Increments the version in the default module header file.

Returns
True on success.

◆ incrementVersion() [2/2]

bool IncrementVersion::incrementVersion ( File & file) const

Increments the version in the specified file.

Parameters
[in]fileThe file to modify.
Returns
True on success.

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