NeoFOAM::RegisterDocumentation< baseClass > Struct Template Reference

Template struct for registering documentation of a base class. More...

#include <runtimeSelectionFactory.hpp>

Public Member Functions
	RegisterDocumentation ()

Static Public Member Functions
static bool	init ()
	Static function to initialize the registration of the class documentation.

Static Public Attributes
static bool	REGISTERED = RegisterDocumentation<baseClass>::init()

Detailed Description

template<class baseClass>
struct NeoFOAM::RegisterDocumentation< baseClass >

Template struct for registering documentation of a base class.

This struct is used to register the documentation of a base class. It provides a static function init() that registers the class documentation by calling BaseClassDocumentation::registerClass(). The registration includes the class name, documentation, schema, and entries.

Template Parameters

baseClass

The base class for which the documentation is being registered.

Definition at line 120 of file runtimeSelectionFactory.hpp.

Constructor & Destructor Documentation

RegisterDocumentation()

template<class baseClass >

NeoFOAM::RegisterDocumentation< baseClass >::RegisterDocumentation ( )

inline

Definition at line 122 of file runtimeSelectionFactory.hpp.

Member Function Documentation

init()

template<class baseClass >

static bool NeoFOAM::RegisterDocumentation< baseClass >::init ( )

inlinestatic

Static function to initialize the registration of the class documentation.

This function is called to register the class documentation by calling BaseClassDocumentation::registerClass(). It includes the class name, documentation, schema, and entries.

Returns

Always returns true.

Definition at line 138 of file runtimeSelectionFactory.hpp.

Member Data Documentation

REGISTERED

template<class baseClass >

bool NeoFOAM::RegisterDocumentation< baseClass >::REGISTERED = RegisterDocumentation<baseClass>::init()

static

Static variable used to trigger the registration of the class documentation.

Definition at line 145 of file runtimeSelectionFactory.hpp.

---

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

• /home/runner/work/NeoFOAM/NeoFOAM/include/NeoFOAM/core/runtimeSelectionFactory.hpp