This class genertaes the documentation of a class usung the class doc attributes. More...

#include <otbWrapperApplicationHtmlDocGenerator.h>

Public Types
typedef ApplicationHtmlDocGenerator	Self

Public Member Functions
	ApplicationHtmlDocGenerator ()
virtual	~ApplicationHtmlDocGenerator ()

Static Public Member Functions
static void	GenerateDoc (const Application::Pointer app, const std::string &filename, const bool showKey=false)
static void	GenerateDoc (const Application::Pointer app, std::string &val, const bool showKey=false)

Static Protected Member Functions
static void	GetDocParameterChoice (const Application::Pointer app, std::string &val, const std::string &key, const bool showKey=false)
static void	GetDocParameterGroup (const Application::Pointer app, std::string &val, const std::string &key, const bool showKey=false)
static void	GetDocParameters (const Application::Pointer app, std::string &val, const bool showKey=false)

Private Member Functions
	ApplicationHtmlDocGenerator (const ApplicationHtmlDocGenerator &)
void	operator= (const ApplicationHtmlDocGenerator &)

Detailed Description

This class genertaes the documentation of a class usung the class doc attributes.

Definition at line 32 of file otbWrapperApplicationHtmlDocGenerator.h.

Member Typedef Documentation

typedef ApplicationHtmlDocGenerator otb::Wrapper::ApplicationHtmlDocGenerator::Self

Standard class typedef

Definition at line 36 of file otbWrapperApplicationHtmlDocGenerator.h.

Constructor & Destructor Documentation

otb::Wrapper::ApplicationHtmlDocGenerator::ApplicationHtmlDocGenerator ( )

Constructor

Definition at line 70 of file otbWrapperApplicationHtmlDocGenerator.cxx.

otb::Wrapper::ApplicationHtmlDocGenerator::~ApplicationHtmlDocGenerator ( )

virtual

Destructor

Definition at line 74 of file otbWrapperApplicationHtmlDocGenerator.cxx.

otb::Wrapper::ApplicationHtmlDocGenerator::ApplicationHtmlDocGenerator ( const ApplicationHtmlDocGenerator & )

private

Member Function Documentation

void otb::Wrapper::ApplicationHtmlDocGenerator::GenerateDoc	(	const Application::Pointer	app,
		const std::string &	filename,
		const bool	showKey = `false`
	)

static

Generate ans dave the documentation. Add the key is the description of the parameter if showKey is set at true.

Definition at line 151 of file otbWrapperApplicationHtmlDocGenerator.cxx.

Referenced by otb::Wrapper::QtWidgetView::CreateDoc().

void otb::Wrapper::ApplicationHtmlDocGenerator::GenerateDoc	(	const Application::Pointer	app,
		std::string &	val,
		const bool	showKey = `false`
	)

static

Generate the documentation as a string. Add the key is the description of the parameter if showKey is set at true.

Definition at line 79 of file otbWrapperApplicationHtmlDocGenerator.cxx.

References GetDocParameters(), otbDocHtmlBodyCodeMacro, otbDocHtmlBodyMacro, otbDocHtmlTitle1Macro, and otbDocHtmlTitleMacro.

void otb::Wrapper::ApplicationHtmlDocGenerator::GetDocParameterChoice	(	const Application::Pointer	app,
		std::string &	val,
		const std::string &	key,
		const bool	showKey = `false`
	)

staticprotected

generate the documentation associated to a choice. Add the key is the description of the parameter if showKey is set at true.

Definition at line 262 of file otbWrapperApplicationHtmlDocGenerator.cxx.

References otb::Wrapper::ChoiceParameter::GetChoiceKeys(), otb::Wrapper::ChoiceParameter::GetChoiceParameterGroupByIndex(), GetDocParameterGroup(), otb::Wrapper::ChoiceParameter::GetNbChoices(), and otbDocHtmlParamMacro.

Referenced by GetDocParameterGroup(), and GetDocParameters().

void otb::Wrapper::ApplicationHtmlDocGenerator::GetDocParameterGroup	(	const Application::Pointer	app,
		std::string &	val,
		const std::string &	key,
		const bool	showKey = `false`
	)

staticprotected

generate the documentation associated to a group. Add the key is the description of the parameter if showKey is set at true.

Definition at line 214 of file otbWrapperApplicationHtmlDocGenerator.cxx.

References GetDocParameterChoice(), otb::Wrapper::ParameterGroup::GetParametersKeys(), otbDocHtmlParamMacro, otb::Wrapper::ParameterType_Choice, and otb::Wrapper::ParameterType_Group.

Referenced by GetDocParameterChoice(), and GetDocParameters().

void otb::Wrapper::ApplicationHtmlDocGenerator::GetDocParameters	(	const Application::Pointer	app,
		std::string &	val,
		const bool	showKey = `false`
	)

staticprotected

Get the parameter description of one parameter. Add the key is the description of the parameter if showKey is set at true.

Definition at line 167 of file otbWrapperApplicationHtmlDocGenerator.cxx.

References GetDocParameterChoice(), GetDocParameterGroup(), otbDocHtmlParamMacro, otb::Wrapper::ParameterType_Choice, and otb::Wrapper::ParameterType_Group.

Referenced by GenerateDoc().

void otb::Wrapper::ApplicationHtmlDocGenerator::operator= ( const ApplicationHtmlDocGenerator & )

private

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

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation