doxygen/generated/_utils_8h_source.html

#pragma once


#include <string>


#include "Enums.h"


using namespace std;


void printInputError(InputErrors inputError);

size_t handleApiCallBack(char* data, size_t size, size_t numOfBytes, string* buffer);

void handleGithubApiErrorCodes(long errorCode, string apiResponse);

CommitTypeMatchResults checkCommitTypeMatch(string commitMessage, int commitTypeIndex);

string convertMarkdownToHtml(string markdownText, string githubToken);

void writeGeneratedNotesInFiles(string markdownGeneratedNotes, string githubToken);

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

InputErrors
InputErrors
Definition Enums.h:19

handleGithubApiErrorCodes
void handleGithubApiErrorCodes(long errorCode, string apiResponse)
Throws runtime exceptions with appropriate messages that describe the given GitHub API error code All...
Definition Utils.cpp:78

checkCommitTypeMatch
CommitTypeMatchResults checkCommitTypeMatch(string commitMessage, int commitTypeIndex)
Checks how the given commit message matches the expected conventional commit type.
Definition Utils.cpp:96

printInputError
void printInputError(InputErrors inputError)
Prints error messages when user runs the script with incorrect parameters/input.
Definition Utils.cpp:27

writeGeneratedNotesInFiles
void writeGeneratedNotesInFiles(string markdownGeneratedNotes, string githubToken)
Writes the generated markdown notes in the markdown file and converts these markdown notes to HTML an...
Definition Utils.cpp:174

convertMarkdownToHtml
string convertMarkdownToHtml(string markdownText, string githubToken)
Converts markdown to HTML using the GitHub API markdown endpoint.
Definition Utils.cpp:116

handleApiCallBack
size_t handleApiCallBack(char *data, size_t size, size_t numOfBytes, string *buffer)
Callback function that is required to handle API response in libcurl.
Definition Utils.cpp:66