Inheritance diagram for TCLAP::DocBookOutput:

Public Member Functions
virtual void	failure (CmdLineInterface &c, ArgException &e)
virtual void	usage (CmdLineInterface &c)
virtual void	version (CmdLineInterface &c)
Protected Member Functions
void	basename (std::string &s)
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)
Protected Attributes
char	theDelimiter

Detailed Description

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

Definition at line 43 of file DocBookOutput.h.

Member Function Documentation

void TCLAP::DocBookOutput::basename ( std::string & s ) [inline, protected]

Definition at line 203 of file DocBookOutput.h.

void TCLAP::DocBookOutput::failure	(	CmdLineInterface &	c,
		ArgException &	e
	)		`[inline, virtual]`

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.

Definition at line 174 of file DocBookOutput.h.

void TCLAP::DocBookOutput::printLongArg ( Arg * it ) [inline, protected]

Definition at line 252 of file DocBookOutput.h.

void TCLAP::DocBookOutput::printShortArg ( Arg * it ) [inline, protected]

Definition at line 212 of file DocBookOutput.h.

void TCLAP::DocBookOutput::removeChar	(	std::string &	s,
		char	r
	)		`[inline, protected]`

Definition at line 194 of file DocBookOutput.h.

void TCLAP::DocBookOutput::substituteSpecialChars	(	std::string &	s,
		char	r,
		std::string &	x
	)		`[inline, protected]`

Substitutes the char r for string x in string s.

Parameters:

Definition at line 182 of file DocBookOutput.h.

void TCLAP::DocBookOutput::usage ( CmdLineInterface & c ) [inline, virtual]

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

Parameters:

c	- The CmdLine object the output is generated for.

Definition at line 95 of file DocBookOutput.h.

void TCLAP::DocBookOutput::version ( CmdLineInterface & c ) [inline, virtual]

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

Parameters:

c	- The CmdLine object the output is generated for.

Definition at line 90 of file DocBookOutput.h.

Definition at line 86 of file DocBookOutput.h.

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