Base class for foam help classes. More...

Inheritance diagram for helpType:

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

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

	helpType ()
	Constructor. More...

virtual	~helpType ()
	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...

Static Public Member Functions
static autoPtr< helpType >	New (const word &helpTypeName)
	Selector. More...

Protected Member Functions
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...

Detailed Description

Base class for foam help classes.

Source files

Definition at line 55 of file helpType.H.

Constructor & Destructor Documentation

helpType ( )

Constructor.

virtual ~helpType ( )

virtual

Destructor.

fileName doxygenPath ( ) const

protected

Return file path to the Doxygen sources (if available)

protected

Display the list of documentation options.

protected

Display the help documentation in a browser.

TypeName ( "helpType" )

Runtime type information.

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

static autoPtr<helpType> New ( const word & helpTypeName )

static

Selector.

virtual void init ( )

virtual

Initialise - typically setting static variables,.

e.g. command line arguments

pure virtual

Execute the help.

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