TCLAP::DocBookOutput Class Reference

#include <DocBookOutput.h>

Inherits TCLAP::CmdLineOutput.

Collaboration diagram for TCLAP::DocBookOutput:

[legend]

List of all members.

Public Member Functions
virtual void	usage (CmdLineInterface &c)
virtual void	version (CmdLineInterface &c)
virtual void	failure (CmdLineInterface &c, ArgException &e)
Protected Member Functions
void	substituteSpecialChars (std::string &s, char r, std::string &x)

---

Detailed Description

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

---

Member Function Documentation

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.

Implements TCLAP::CmdLineOutput.

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:

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

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.

Implements TCLAP::CmdLineOutput.

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.

Implements TCLAP::CmdLineOutput.