ConfigInfo Class Reference

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

#include <src/configimpl.h>

Inheritance diagram for ConfigInfo:

Collaboration diagram for ConfigInfo:

Public Member Functions
	ConfigInfo (const char *name, const char *doc)
void	writeTemplate (TextStream &t, bool sl, bool) override
void	compareDoxyfile (TextStream &, Config::CompareMode) override
void	writeXMLDoxyfile (TextStream &) override
void	writeXSDDoxyfile (TextStream &t) override
void	substEnvVars () override
Public Member Functions inherited from ConfigOption
	ConfigOption (OptionType t)
OptionType	kind () const
DString	name () const
DString	docs () const
DString	dependsOn () const
void	addDependency (const char *dep)
void	setEncoding (const DString &e)
void	setUserComment (const DString &u)

Additional Inherited Members
Public Types inherited from ConfigOption
enum	OptionType {   O_Info , O_List , O_Enum , O_String ,   O_Int , O_Bool , O_Obsolete , O_Disabled }
enum	{ MAX_OPTION_LENGTH = 23 }
Protected Member Functions inherited from ConfigOption
virtual void	convertStrToVal (Config::CompareMode)
virtual void	emptyValueToDefault ()
virtual void	init ()
virtual bool	isDefault ()
void	writeBoolValue (TextStream &t, bool v, bool initSpace=true)
void	writeIntValue (TextStream &t, int i, bool initSpace=true)
void	writeStringValue (TextStream &t, const DString &s, bool initSpace=true, bool wasQuoted=false)
void	writeStringList (TextStream &t, const StringVector &l)
Protected Attributes inherited from ConfigOption
DString	m_spaces
DString	m_name
DString	m_doc
DString	m_dependency
DString	m_encoding
DString	m_userComment
OptionType	m_kind

Detailed Description

Section marker for grouping the configuration options.

Definition at line 106 of file configimpl.h.

Constructor & Destructor Documentation

ConfigInfo()

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

inline

Definition at line 109 of file configimpl.h.

      : ConfigOption(O_Info)
    {
      m_name = name;
      m_doc = doc;
    }

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

Referenced by ConfigImpl::addInfo().

Member Function Documentation

compareDoxyfile()

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

inlineoverridevirtual

Implements ConfigOption.

Definition at line 116 of file configimpl.h.

{}

substEnvVars()

void ConfigInfo::substEnvVars ( )

inlineoverridevirtual

Implements ConfigOption.

Definition at line 119 of file configimpl.h.

{}

writeTemplate()

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

overridevirtual

Implements ConfigOption.

Definition at line 357 of file configimpl.l.

{
  if (!sl)
  {
    t << "\n";
  }
  t << "#---------------------------------------------------------------------------\n";
  t << "# " << m_doc << "\n";
  t << "#---------------------------------------------------------------------------\n";
}

References ConfigOption::m_doc.

writeXMLDoxyfile()

void ConfigInfo::writeXMLDoxyfile ( TextStream & )

inlineoverridevirtual

Implements ConfigOption.

Definition at line 117 of file configimpl.h.

{}

writeXSDDoxyfile()

void ConfigInfo::writeXSDDoxyfile ( TextStream & t )

inlineoverridevirtual

Implements ConfigOption.

Definition at line 118 of file configimpl.h.

{}

---

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

• src/configimpl.h
• src/configimpl.l