Inheritance diagram for helpFunctionObject:

Collaboration diagram for helpFunctionObject:

Public Member Functions
	TypeName ("helpFunctionObject")
	Runtime type information.
	helpFunctionObject ()
	Constructor.
virtual	~helpFunctionObject ()
	Destructor.
virtual void	init ()
	Initialise - typically setting static variables,.
virtual void	execute (const argList &args, const fvMesh &mesh)
	Execute the help.
Public Member Functions inherited from helpType
	TypeName ("helpType")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, helpType, dictionary,(),())
	helpType ()=default
	Default construct.
virtual	~helpType ()=default
	Destructor.

Additional Inherited Members
Static Public Member Functions inherited from helpType
static autoPtr< helpType >	New (const word &helpTypeName)
	Selector.
Protected Member Functions inherited from helpType
fileName	doxygenPath () const
	Return file path to the Doxygen sources (if available).
void	displayDocOptions (const string &searchStr, const bool exactMatch, const word &ext) const
	Display the list of documentation options.
void	displayDoc (const word &className, const string &searchStr, const bool exactMatch, const word &ext) const
	Display the help documentation in a browser.

Detailed Description

Definition at line 62 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 void execute	(	const argList &	args,
		const fvMesh &	mesh )

virtual

Execute the help.

Implements helpType.

References args, and mesh.

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

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