My Project
 All Classes Files Functions Variables Enumerations Enumerator Friends Macros Pages
gcp::util::HtmlDoc Class Reference

Public Member Functions

 HtmlDoc ()
 
virtual ~HtmlDoc ()
 

Static Public Member Functions

static void generateAutoDocumentation (Script *sc, std::string dir)
 
static void createDirs (std::string &dir)
 
static void writeHtmlStyleSheet (Script *sc, std::string &dir)
 
static void writeHtmlCommandIndexFile (Script *sc, std::string &dir)
 
static void writeHtmlCommandList (Script *sc, std::string &dir)
 
static void writeHtmlHeader (std::ofstream &fout, std::string path)
 
static void writeHtmlFooter (std::ofstream &fout)
 
static void writeHtmlCommandSynopsisFile (std::string &dir, ScriptCmd &cmd)
 
static void writeHtmlCommandUsageFile (std::string &dir, ScriptCmd &cmd)
 
static void writeHtmlFunctionSynopsisFile (std::string &dir, ScriptCmd &cmd)
 
static void writeHtmlFunctionUsageFile (std::string &dir, ScriptCmd &cmd)
 
static void writeHtmlSymbolSynopsisFile (std::string &dir, ScriptCmd &cmd)
 
static void writeHtmlSymbolUsageFile (std::string &dir, ScriptCmd &cmd)
 
static void writeHtmlDataTypes (Script *sc, std::string &dir)
 
static void writeHtmlDataTypeFiles (std::string &dir, ScriptDataType &type)
 
static void writeDataType (std::ofstream &fout, ScriptDataType &type)
 
static void writeHtmlDataTypeSynopsisFile (std::string &dir, ScriptDataType &type)
 
static void writeHtmlDataTypeUsageFile (std::string &dir, ScriptDataType &type)
 
static void writeHtmlDataTypeIndexFile (std::string &dir, ScriptDataType &type)
 

Constructor & Destructor Documentation

HtmlDoc::HtmlDoc ( )

Constructor.

....................................................................... Constructor.

HtmlDoc::~HtmlDoc ( )
virtual

Destructor.

....................................................................... Destructor.

Member Function Documentation

void HtmlDoc::writeHtmlDataTypeFiles ( std::string &  dir,
ScriptDataType type 
)
static

....................................................................... Write all files for a single data type

void HtmlDoc::writeHtmlDataTypeIndexFile ( std::string &  dir,
ScriptDataType type 
)
static

....................................................................... Write the index file for a data type

void HtmlDoc::writeHtmlDataTypes ( Script sc,
std::string &  dir 
)
static

....................................................................... Write out documentation about all known data types

void HtmlDoc::writeHtmlDataTypeSynopsisFile ( std::string &  dir,
ScriptDataType type 
)
static

....................................................................... Write the synopsis of a data type


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