DtCmdLine::DocBookOutput Class Reference

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

Inheritance diagram for DtCmdLine::DocBookOutput:

Collaboration diagram for DtCmdLine::DocBookOutput:

Public Member Functions
virtual void	usage (CmdLineInterface &c)
	Prints the usage to stdout.
virtual void	version (CmdLineInterface &c)
	Prints the version to stdout.
virtual void	failure (CmdLineInterface &c, ArgException &e)
	Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior.
Public Member Functions inherited from DtCmdLine::CmdLineOutput
	CmdLineOutput ()
virtual	~CmdLineOutput ()

Protected Member Functions
void	substituteSpecialChars (std::string &s, char r, std::string &x)
	Substitutes the char r for string x in string s.

Detailed Description

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

Member Function Documentation

void DtCmdLine::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 DtCmdLine::CmdLineOutput.

References DtCmdLine::ArgException::what().

void DtCmdLine::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.

void DtCmdLine::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 DtCmdLine::CmdLineOutput.

References DtCmdLine::XorHandler::contains(), DtCmdLine::CmdLineInterface::getArgList(), DtCmdLine::CmdLineInterface::getProgramName(), DtCmdLine::CmdLineInterface::getXorHandler(), and DtCmdLine::XorHandler::getXorList().

void DtCmdLine::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 DtCmdLine::CmdLineOutput.

References DtCmdLine::CmdLineInterface::getVersion().

---

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

• cmdDocBookOutput.h