Contains data for a single change in the changelog.
More...
#include <changelogentry.h>
|
enum | ChangeType { new_feature = 0
, change = 1
, fix = 2
, no_type = 100
} |
| Represents the type of change for a changelog entry.
|
|
|
ChangeType | type_ |
| Type of this change.
|
|
std::string | short_description_ |
| Short description of the change.
|
|
std::string | long_description_ |
| Optional: A more detailed description or an explanation.
|
|
int | issue_ = -1 |
| GitHub issue addressed by this change, or -1 if not related to any issue.
|
|
int | pull_request_ = -1 |
| GitHub pull request responsible for this change or -1 if not related to a PR.
|
|
Contains data for a single change in the changelog.
◆ ChangelogEntry()
ChangelogEntry::ChangelogEntry |
( |
const Json::Value & | json | ) |
|
Deserializes a changelog entry from the given JSON object.
- Parameters
-
json | JSON object containing the changelog entry. |
◆ getIssue()
int ChangelogEntry::getIssue |
( |
| ) |
const |
Getter for the GitHub issue ID.
- Returns
- The issue ID.
◆ getLongDescription()
std::string ChangelogEntry::getLongDescription |
( |
| ) |
const |
Getter for the long description.
- Returns
- The description.
◆ getPullRequest()
int ChangelogEntry::getPullRequest |
( |
| ) |
const |
Getter for the GitHub pull request ID.
- Returns
- The pull request ID.
◆ getShortDescription()
std::string ChangelogEntry::getShortDescription |
( |
| ) |
const |
Getter for the short description.
- Returns
- The description.
◆ getType()
Getter for the change type.
- Returns
- The type.
◆ operator<()
Compares this and other by their type.
- Parameters
-
- Returns
- True if type of this is less than type of other.
The documentation for this class was generated from the following files: