Go to the documentation of this file. 1 #ifndef WIBBLE_COMMANDLINE_DOC_H
2 #define WIBBLE_COMMANDLINE_DOC_H
10 namespace commandline {
21 DocMaker(
const std::string& app,
const std::string& ver)
31 Help(
const std::string& app,
const std::string& ver)
50 Hook(
const std::string& section,
where placement,
const std::string& text)
51 : section(section), placement(placement), text(text) {}
57 std::vector<Hook> hooks;
58 std::string lastSection;
60 void outputParagraph(std::ostream& out,
const std::string& str);
61 void outputOption(std::ostream& out,
const Option* o);
62 void outputOptions(std::ostream& out,
const Engine& p);
63 void runHooks(std::ostream& out,
const std::string& section,
where where);
64 void startSection(std::ostream& out,
const std::string& name);
65 void endSection(std::ostream& out);
69 Manpage(
const std::string& app,
const std::string& ver,
int section,
const std::string& author)
70 :
DocMaker(app, ver), m_section(section), m_author(author) {}
72 void addHook(
const std::string& section,
where placement,
const std::string& text)
74 hooks.push_back(Hook(section, placement, text));
std::string m_ver
Definition: doc.h:18
const std::string & name() const
Definition: engine.h:107
void output(std::ostream &out, const Engine &cp)
Definition: doc.cpp:326
@ END
Definition: doc.h:41
const std::vector< OptionGroup * > & groups() const
Get the OptionGroups that have been added to this engine.
Definition: engine.h:191
void readHooks(const std::string &file)
Definition: doc.cpp:409
std::string longDescription
Definition: engine.h:224
bool hasOptions() const
Returns true if this Engine has options to parse.
Definition: engine.h:209
Manpage(const std::string &app, const std::string &ver, int section, const std::string &author)
Definition: doc.h:69
std::string usage
Definition: engine.h:222
std::vector< std::string > aliases
Definition: engine.h:221
std::string primaryAlias
Definition: engine.h:220
const std::vector< Option * > & options() const
Get the Options that have been added to this engine.
Definition: engine.h:194
@ BEGINNING
Definition: doc.h:41
void output(List l, Out it)
Definition: list.h:415
void outputHelp(std::ostream &out, const Engine &cp)
Definition: doc.cpp:145
const std::vector< Engine * > & commands() const
Get the Engines that have been added to this engine.
Definition: engine.h:197
Parse commandline options.
Definition: engine.h:38
std::string m_app
Definition: doc.h:17
where
Definition: doc.h:41
@ BEFORE
Definition: doc.h:41
std::string description
Definition: engine.h:223
size_t size(const std::string &file)
File size.
Definition: fs.cpp:287
void addHook(const std::string §ion, where placement, const std::string &text)
Definition: doc.h:72
void outputVersion(std::ostream &out)
Definition: doc.cpp:140
file(GLOB TEST_SOURCES test_ *.cpp) ADD_CUSTOM_TARGET(check COMMAND make libwibble-test &&$
Definition: tests/CMakeLists.txt:3
DocMaker(const std::string &app, const std::string &ver)
Definition: doc.h:21
void outputOptions(std::ostream &out, HelpWriter &writer, const Engine &cp)
Definition: doc.cpp:77
Exception thrown when some consistency check fails.
Definition: exception.h:254
void now(int *dst)
Fill in an int[6] with the UTC values for now.
Base class for exceptions for file I/O.
Definition: exception.h:420
Help(const std::string &app, const std::string &ver)
Definition: doc.h:31