Public Member Functions | List of all members
ConfigInfo Class Reference

#include <config.h>

Inheritance diagram for ConfigInfo:
ConfigOption

Public Member Functions

 ConfigInfo (const char *name, const char *doc)
 
void writeTemplate (FTextStream &t, bool sl, bool)
 
void substEnvVars ()
 
- Public Member Functions inherited from ConfigOption
 ConfigOption (OptionType t)
 
virtual ~ConfigOption ()
 
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 ()
 
virtual void init ()
 
void writeBoolValue (FTextStream &t, bool v)
 
void writeIntValue (FTextStream &t, int i)
 
void writeStringValue (FTextStream &t, QCString &s)
 
void writeStringList (FTextStream &t, QStrList &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 96 of file config.h.

Constructor & Destructor Documentation

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

Definition at line 99 of file config.h.

101  {
102  m_name = name;
103  m_doc = doc;
104  }
QCString m_name
Definition: config.h:86
ConfigOption(OptionType t)
Definition: config.h:56
QCString m_doc
Definition: config.h:87
QCString name() const
Definition: config.h:66
QCString doc

Member Function Documentation

void ConfigInfo::substEnvVars ( )
inlinevirtual

Implements ConfigOption.

Definition at line 106 of file config.h.

106 {}
void ConfigInfo::writeTemplate ( FTextStream t,
bool  sl,
bool   
)
virtual

Implements ConfigOption.

Definition at line 910 of file config.cpp.

911 {
912  if (!sl)
913  {
914  t << "\n";
915  }
916  t << "#---------------------------------------------------------------------------\n";
917  t << "# " << m_doc << endl;
918  t << "#---------------------------------------------------------------------------\n";
919 }
QCString m_doc
Definition: config.h:87
QTextStream & endl(QTextStream &s)

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