doxygen
|
Public function to deal with the configuration file. More...
Functions | |
void | init () |
void | writeTemplate (FTextStream &t, bool shortList, bool updateOnly=FALSE) |
void | compareDoxyfile (FTextStream &t) |
bool | parse (const char *fileName, bool update=FALSE) |
void | postProcess (bool clearHeaderAndFooter, bool compare=FALSE) |
void | checkAndCorrect () |
void | deinit () |
Public function to deal with the configuration file.
void Config::checkAndCorrect | ( | ) |
Check the validity of the parsed options and correct or warn the user where needed.
void Config::compareDoxyfile | ( | FTextStream & | t | ) |
Writes a the differences between the current configuration and the template configuration to stream t.
void Config::deinit | ( | ) |
Clean up any data
void Config::init | ( | ) |
Initialize configuration variables to their default value
bool Config::parse | ( | const char * | fileName, |
bool | update = FALSE |
||
) |
Parses a configuration file with name fn.
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. |
void Config::writeTemplate | ( | FTextStream & | 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.