OTB  5.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Private Member Functions | List of all members
otb::Wrapper::ApplicationHtmlDocGenerator Class Reference

#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 34 of file otbWrapperApplicationHtmlDocGenerator.h.

Member Typedef Documentation

Standard class typedef

Definition at line 38 of file otbWrapperApplicationHtmlDocGenerator.h.

Constructor & Destructor Documentation

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

Constructor

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

Destructor

otb::Wrapper::ApplicationHtmlDocGenerator::ApplicationHtmlDocGenerator ( const ApplicationHtmlDocGenerator )
private

Member Function Documentation

static 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.

static 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.

static 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.

static 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.

static 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.

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

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