ecl::DocBookOutput Class Reference

TClap class used for generating docbook output. More...

#include <docbook_output.hpp>

Inheritance diagram for ecl::DocBookOutput:

Public Member Functions
virtual void	failure (CmdLineInterface &c, ArgException &e)
virtual void	usage (CmdLineInterface &c)
virtual void	version (CmdLineInterface &c)
Public Member Functions inherited from ecl::CmdLineOutput
virtual	~CmdLineOutput ()

Protected Member Functions
void	printLongArg (Arg *it)
void	printShortArg (Arg *it)
void	removeChar (std::string &s, char r)
void	substituteSpecialChars (std::string &s, char r, std::string &x)

Detailed Description

TClap class used for generating docbook output.

A class that generates DocBook output for usage() method for the given CmdLine and its Args.

Definition at line 39 of file docbook_output.hpp.

Member Function Documentation

failure()

void ecl::DocBookOutput::failure ( CmdLineInterface &  c, ArgException &  e  )

inlinevirtual

Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior.

Parameters

c	- The CmdLine object the output is generated for.
e	- The ArgException that caused the failure.

Implements ecl::CmdLineOutput.

Definition at line 188 of file docbook_output.hpp.

printLongArg()

void ecl::DocBookOutput::printLongArg ( Arg *  it )

inlineprotected

Definition at line 242 of file docbook_output.hpp.

printShortArg()

void ecl::DocBookOutput::printShortArg ( Arg *  it )

inlineprotected

Definition at line 215 of file docbook_output.hpp.

removeChar()

void ecl::DocBookOutput::removeChar ( std::string &  s, char  r  )

inlineprotected

Definition at line 206 of file docbook_output.hpp.

substituteSpecialChars()

void ecl::DocBookOutput::substituteSpecialChars ( std::string &  s, char  r, std::string &  x  )

inlineprotected

Substitutes the char r for string x in string s.

Parameters

s	- The string to operate on.
r	- The char to replace.
x	- What to replace r with.

Definition at line 194 of file docbook_output.hpp.

usage()

void ecl::DocBookOutput::usage ( CmdLineInterface &  c )

inlinevirtual

Prints the usage to stdout. Can be overridden to produce alternative behavior.

Parameters

c	- The CmdLine object the output is generated for.

Implements ecl::CmdLineOutput.

Definition at line 88 of file docbook_output.hpp.

version()

void ecl::DocBookOutput::version ( CmdLineInterface &  c )

inlinevirtual

Prints the version to stdout. Can be overridden to produce alternative behavior.

Parameters

c	- The CmdLine object the output is generated for.

Implements ecl::CmdLineOutput.

Definition at line 83 of file docbook_output.hpp.

---

The documentation for this class was generated from the following file:

• docbook_output.hpp