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
QCString	name () const
QCString	docs () const
QCString	dependsOn () const
void	addDependency (const char *dep)
void	setEncoding (const QCString &e)
void	setUserComment (const QCString &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 QCString &s, bool initSpace=true, bool wasQuoted=false)
void	writeStringList (TextStream &t, const StringVector &l)
Protected Attributes inherited from ConfigOption
QCString	m_spaces
QCString	m_name
QCString	m_doc
QCString	m_dependency
QCString	m_encoding
QCString	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.

Member Function Documentation

◆ compareDoxyfile()

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

inlineoverridevirtual

Implements ConfigOption.

Definition at line 116 of file configimpl.h.

116{}

◆ substEnvVars()

void ConfigInfo::substEnvVars ( )

inlineoverridevirtual

Implements ConfigOption.

Definition at line 119 of file configimpl.h.

119{}

◆ 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";
}