cpp-project-template/UserOpt_8hpp_source.html

#ifndef CPP_PROJ_USEROPT_HPP

#define CPP_PROJ_USEROPT_HPP


#include <span>

#include <string_view>


namespace cpp_proj

{


inline std::string_view

    progName;  // NOLINT: Yes, I know that global variables should

               // be constant (whenever possible) and carefully used.

               // In this case it should be fine.


void parseUserOptions(const std::span<char*>& args);


void printHelp();

void printVersion();

[[noreturn]] void printHelpAndExit();

[[noreturn]] void printVersionAndExit();


}  // namespace cpp_proj


#endif

cpp_proj
Namespace for this application.
Definition UserOpt.cpp:12

cpp_proj::progName
std::string_view progName
This application's executable name, to be set at the start of the main function.
Definition UserOpt.hpp:24

cpp_proj::printHelp
void printHelp()
Print the usage of the application.
Definition UserOpt.cpp:14

cpp_proj::printVersionAndExit
void printVersionAndExit()
Calls cpp_proj::printVersion and exits with success.
Definition UserOpt.cpp:37

cpp_proj::parseUserOptions
void parseUserOptions(const std::span< char * > &args)
Gets the user options from the command line.
Definition UserOpt.cpp:43

cpp_proj::printHelpAndExit
void printHelpAndExit()
Calls cpp_proj::printHelp and exits with success.
Definition UserOpt.cpp:31

cpp_proj::printVersion
void printVersion()
Print the version of the application.
Definition UserOpt.cpp:22