Skip to main content

The ConfigInfo Class Reference

Section marker for grouping the configuration options. More...

Declaration​

class ConfigInfo { ... }

Included Headers​

#include <src/configimpl.h>

Base class​

classConfigOption

Abstract base class for any configuration option. More...

Public Constructors Index​

ConfigInfo (const char *name, const char *doc)

Public Member Functions Index​

voidwriteTemplate (TextStream &t, bool sl, bool) override
voidcompareDoxyfile (TextStream &, Config::CompareMode) override
voidwriteXMLDoxyfile (TextStream &) override
voidwriteXSDDoxyfile (TextStream &t) override
voidsubstEnvVars () override

Description​

Section marker for grouping the configuration options.

Definition at line 106 of file configimpl.h.

Public Constructors​

ConfigInfo()​

ConfigInfo::ConfigInfo (const char * name, const char * doc)
 inline

Definition at line 109 of file configimpl.h.

109 ConfigInfo(const char *name,const char *doc)
110 : ConfigOption(O_Info)
111 {
112 m_name = name;
113 m_doc = doc;
114 }

References ConfigOption::ConfigOption, ConfigOption::m_doc, ConfigOption::m_name, ConfigOption::name and ConfigOption::O_Info.

Public Member Functions​

compareDoxyfile()​

void ConfigInfo::compareDoxyfile (TextStream &, Config::CompareMode)
 inline virtual

Definition at line 116 of file configimpl.h.

116 void compareDoxyfile(TextStream &,Config::CompareMode) override {}

substEnvVars()​

void ConfigInfo::substEnvVars ()
 inline virtual

Definition at line 119 of file configimpl.h.

119 void substEnvVars() override {}

writeTemplate()​

void ConfigInfo::writeTemplate (TextStream & t, bool sl, bool)
 virtual

Declaration at line 115 of file configimpl.h, definition at line 357 of file configimpl.l.

357void ConfigInfo::writeTemplate(TextStream &t, bool sl,bool)
358{
359 if (!sl)
360 {
361 t << "\n";
362 }
363 t << "#---------------------------------------------------------------------------\n";
364 t << "# " << m_doc << "\n";
365 t << "#---------------------------------------------------------------------------\n";
366}

Reference ConfigOption::m_doc.

writeXMLDoxyfile()​

void ConfigInfo::writeXMLDoxyfile (TextStream &)
 inline virtual

Definition at line 117 of file configimpl.h.

117 void writeXMLDoxyfile(TextStream &) override {}

writeXSDDoxyfile()​

void ConfigInfo::writeXSDDoxyfile (TextStream & t)
 inline virtual

Definition at line 118 of file configimpl.h.

118 void writeXSDDoxyfile(TextStream &t) override {}

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.