Inheritance diagram for helpFunctionObject:

Collaboration diagram for helpFunctionObject:

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

Public Member Functions inherited from helpType
	TypeName ("helpType")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, helpType, dictionary,(),())

	helpType ()=default
	Default construct. More...

virtual	~helpType ()=default
	Destructor. More...

virtual void	init ()
	Initialise - typically setting static variables,. More...

virtual void	execute (const argList &args, const fvMesh &mesh)=0
	Execute the help. More...

Additional Inherited Members
Static Public Member Functions inherited from helpType
static autoPtr< helpType >	New (const word &helpTypeName)
	Selector. More...

Protected Member Functions inherited from helpType
fileName	doxygenPath () const
	Return file path to the Doxygen sources (if available) More...

void	displayDocOptions (const string &searchStr, const bool exactMatch, const word &ext) const
	Display the list of documentation options. More...

void	displayDoc (const word &className, const string &searchStr, const bool exactMatch, const word &ext) const
	Display the help documentation in a browser. More...

Detailed Description

Definition at line 66 of file helpFunctionObject.H.

Constructor & Destructor Documentation

helpFunctionObject ( )

Constructor.

virtual ~helpFunctionObject ( )

virtual

Destructor.

TypeName ( "helpFunctionObject" )

Runtime type information.

virtual void init ( )

virtual

Initialise - typically setting static variables,.

e.g. command line arguments

Reimplemented from helpType.

virtual

Execute the help.

Implements helpType.

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

applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H