Config 命名空间参考

Public function to deal with the configuration file. 更多...

函数
void	init ()
void	writeTemplate (TextStream &t, bool shortList, bool updateOnly=FALSE)
void	compareDoxyfile (TextStream &t)
void	writeXMLDoxyfile (TextStream &t)
bool	parse (const QCString &fileName, bool update=FALSE)
void	postProcess (bool clearHeaderAndFooter, bool compare=FALSE)
void	checkAndCorrect (bool quiet)
void	updateObsolete ()
void	deinit ()

详细描述

Public function to deal with the configuration file.

函数说明

checkAndCorrect()

void Config::checkAndCorrect

(

bool

quiet

)

Check the validity of the parsed options and correct or warn the user where needed.

参数

quiet

setting for the QUIET option (can have been overruled by means of a command line option)

被这些函数引用 checkConfiguration() , 以及 readConfiguration().

compareDoxyfile()

void Config::compareDoxyfile

(

TextStream &

t

)

Writes a the differences between the current configuration and the template configuration to stream t.

被这些函数引用 compareDoxyfile().

deinit()

void Config::deinit

(

)

Clean up any data

被这些函数引用 generateOutput().

init()

void Config::init

(

)

Initialize configuration variables to their default value

被这些函数引用 addEnumValuesToEnums(), addVariableToClass(), addVariableToFile(), readConfiguration(), ConceptDefImpl::setInitializer() , 以及 MemberDefImpl::writeDocumentation().

parse()

bool Config::parse	(	const QCString &	fileName,
		bool	update = FALSE
	)

Parses a configuration file with name fn.

返回

TRUE if successful, FALSE if the file could not be opened or read.

被这些函数引用 readConfiguration().

postProcess()

void Config::postProcess	(	bool	clearHeaderAndFooter,
		bool	compare = FALSE
	)

Post processed the parsed data. Replaces raw string values by the actual values. and replaces environment variables.

参数

clearHeaderAndFooter	set to TRUE when writing header and footer templates.
compare	signals if we in Doxyfile compare (-x) mode are or not. Influences setting of the default value.

被这些函数引用 checkConfiguration() , 以及 readConfiguration().

updateObsolete()

void Config::updateObsolete

(

)

Adjust any configuration values based on the value of obsolete options.

被这些函数引用 checkConfiguration() , 以及 readConfiguration().

writeTemplate()

void Config::writeTemplate	(	TextStream &	t,
		bool	shortList,
		bool	updateOnly = FALSE
	)

Writes a template configuration to stream t. If shortList is TRUE the description of each configuration option will be omitted.

被这些函数引用 generateConfigFile().

writeXMLDoxyfile()

void Config::writeXMLDoxyfile

(

TextStream &

t

)

Writes a the used settings of the current configuration as XML format to stream t.

被这些函数引用 generateXML().