Function CreateFile

docs/OptionDocumentationGenerator.cpp:17–44

\brief Create a markdown file which contains the information about the option.

/// \brief Create a markdown file which contains the information about the option.
static bool CreateFile(const std::string& optionName, bool optionDefault, const char* description)
{
    const std::string mdFileName{"opt-" + optionName + ".md"};
    ofstream          mdFile{mdFileName};

    if(not mdFile.is_open()) {
        return false;
    }

    cout << "Generating: " << mdFileName << "\n";
    std::string linkName{optionName};
    std::replace(linkName.begin(), linkName.end(), '-', '_');

    mdFile << "# " << optionName << " {#" << linkName << "}\n";
    mdFile << description << "\n\n";
    mdFile << "__Default:__ " << (optionDefault ? "On" : "Off") << "\n\n";
    mdFile << "__Examples:__\n\n";
    mdFile << "```.cpp\n";
    mdFile << optionName << "-source\n";
    mdFile << "```\n\n";
    mdFile << "transforms into this:\n\n";
    mdFile << "```.cpp\n";
    mdFile << optionName << "-transformed\n";
    mdFile << "```\n";
    mdFile.close();

    return true;
}

int main()
{