doxygen/generated/_format_8h_source.html

#pragma once


#include <string>

#include "Enums.h"


using namespace std;


string indentAllLinesInString(string s);

string replaceHashIdsWithLinks(string pullRequestBody);

string replaceCommitShasWithLinks(string pullRequestBody);

string removeExtraNewLines(string pullRequestBody);

string formatPullRequestBody(string pullRequestBody);

string convertConventionalCommitTitleToReleaseNoteTitle(string conventionalCommitTitle, CommitTypeMatchResults matchResult,

                                                        string markdownPrefix);

Enums.h
This file contains all the enums used in the whole program.

CommitTypeMatchResults
CommitTypeMatchResults
Enumeration for the result of matching a commit type (e.g., fix: or fix(GUI):) against any commit typ...
Definition Enums.h:42

replaceHashIdsWithLinks
string replaceHashIdsWithLinks(string pullRequestBody)
Replaces all plain text hash ids (issue ids and pull request ids (#2777)) with links to these issues/...
Definition Format.cpp:44

indentAllLinesInString
string indentAllLinesInString(string s)
Indents (puts 4 spaces) before all lines in a string.
Definition Format.cpp:24

convertConventionalCommitTitleToReleaseNoteTitle
string convertConventionalCommitTitleToReleaseNoteTitle(string conventionalCommitTitle, CommitTypeMatchResults matchResult, string markdownPrefix)
Converts the given conventional commit title to a better markdown title that could be used in the rel...
Definition Format.cpp:139

replaceCommitShasWithLinks
string replaceCommitShasWithLinks(string pullRequestBody)
Replaces all plain text commit SHAs (e.g., 219c2149) with links to these commits on GitHub.
Definition Format.cpp:75

removeExtraNewLines
string removeExtraNewLines(string pullRequestBody)
Remove extra new lines in retrieved PR description to make it look identical to the PR description on...
Definition Format.cpp:106

formatPullRequestBody
string formatPullRequestBody(string pullRequestBody)
Makes the formatting of the retrieved PR body look like the PR on GitHub.
Definition Format.cpp:123