Documentation Class Reference

MinitScript documentation. More...

#include <minitscript/minitscript/Documentation.h>

Collaboration diagram for Documentation:

Static Public Member Functions
static const set< string >	getAllClassMethods (MinitScript *minitScript)
	Get all class method names. More...
static const set< string >	getMethodsCategories (MinitScript *minitScript, const set< string > &allClassMethods, MinitScript *excludeMinitScript=nullptr)
	Generate methods categories. More...
static const string	generateClassesDocumentation (const string &heading, int mainHeadingIdx, MinitScript *minitScript, Properties &descriptions, const string &descriptionPrefix, const set< string > &allClassMethods)
	Generate classes documentation. More...
static const string	generateMethodsDocumentation (const string &heading, int mainHeadingIdx, MinitScript *minitScript, Properties &descriptions, const string &descriptionPrefix, const set< string > &allClassMethods, MinitScript *excludeMinitScript=nullptr)
	Generate methods documentation. More...
static const string	generateOperatorsDocumentation (const string &heading, int mainHeadingIdx, MinitScript *minitScript)
	Generate operators documentation. More...
static const string	generateVariablesDocumentation (const string &heading, int mainHeadingIdx, MinitScript *minitScript)
	Generate variables documentation. More...

Detailed Description

MinitScript documentation.

Author

Andreas Drewke

Definition at line 21 of file Documentation.h.

Member Function Documentation

getAllClassMethods()

const set< string > getAllClassMethods ( MinitScript *  minitScript )

static

Get all class method names.

Parameters

minitScript

MinitScript script instance

Returns

all class method names

Definition at line 30 of file Documentation.cpp.

getMethodsCategories()

const set< string > getMethodsCategories ( MinitScript *  minitScript, const set< string > &  allClassMethods, MinitScript *  excludeMinitScript = nullptr  )

static

Generate methods categories.

Parameters

minitScript	MinitScript script instance
allClassMethods	all class methods
excludeMinitScript	exclude MinitScript script instance

Returns

methods categories

Definition at line 72 of file Documentation.cpp.

generateClassesDocumentation()

const string generateClassesDocumentation ( const string &  heading, int  mainHeadingIdx, MinitScript *  minitScript, Properties &  descriptions, const string &  descriptionPrefix, const set< string > &  allClassMethods  )

static

Generate classes documentation.

Parameters

heading	heading
mainHeadingIdx	main heading index
minitScript	MinitScript script instance
descriptions	descriptions
descriptionPrefix	description prefix
allClassMethods	all class methods

Returns

documentation

Definition at line 86 of file Documentation.cpp.

generateMethodsDocumentation()

const string generateMethodsDocumentation ( const string &  heading, int  mainHeadingIdx, MinitScript *  minitScript, Properties &  descriptions, const string &  descriptionPrefix, const set< string > &  allClassMethods, MinitScript *  excludeMinitScript = nullptr  )

static

Generate methods documentation.

Parameters

heading	heading
mainHeadingIdx	main heading index
minitScript	MinitScript script instance
descriptions	descriptions
descriptionPrefix	desscription prefix
allClassMethods	all class methods
excludeMinitScript	exclude MinitScript script instance

Returns

documentation

Definition at line 176 of file Documentation.cpp.

generateOperatorsDocumentation()

const string generateOperatorsDocumentation ( const string &  heading, int  mainHeadingIdx, MinitScript *  minitScript  )

static

Generate operators documentation.

Parameters

heading	heading
mainHeadingIdx	main heading index
minitScript	MinitScript script instance

Returns

documentation

Definition at line 255 of file Documentation.cpp.

generateVariablesDocumentation()

const string generateVariablesDocumentation ( const string &  heading, int  mainHeadingIdx, MinitScript *  minitScript  )

static

Generate variables documentation.

Parameters

heading	heading
mainHeadingIdx	main heading index
minitScript	MinitScript script instance

Returns

documentation

Definition at line 290 of file Documentation.cpp.

---

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

• /home/andreas/Development/drewke.net/minitscript/src/minitscript/minitscript/Documentation.h
• /home/andreas/Development/drewke.net/minitscript/src/minitscript/minitscript/Documentation.cpp