Public Member Functions | |
TypeName ("helpFunctionObject") | |
Runtime type information. More... | |
helpFunctionObject () | |
Constructor. More... | |
virtual | ~helpFunctionObject () |
Destructor. More... | |
virtual void | init () |
Initialise - typically setting static variables,. More... | |
virtual void | execute (const argList &args, const fvMesh &mesh) |
Execute the help. More... | |
![]() | |
TypeName ("helpType") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, helpType, dictionary,(),()) | |
helpType () | |
Constructor. More... | |
virtual | ~helpType () |
Destructor. More... | |
Additional Inherited Members | |
![]() | |
static autoPtr< helpType > | New (const word &helpTypeName) |
Selector. More... | |
![]() | |
fileName | doxygenPath () const |
Return file path to the Doxygen sources (if available) More... | |
void | displayDocOptions (const string &searchStr, const bool exactMatch) const |
Display the list of documentation options. More... | |
void | displayDoc (const word &className, const string &searchStr, const bool exactMatch) const |
Display the help documentation in a browser. More... | |
Definition at line 64 of file helpFunctionObject.H.
Constructor.
|
virtual |
Destructor.
TypeName | ( | "helpFunctionObject" | ) |
Runtime type information.
|
virtual |
Initialise - typically setting static variables,.
e.g. command line arguments
Reimplemented from helpType.
Execute the help.
Implements helpType.