diff options
Diffstat (limited to 'src/configoptions.cpp')
| -rw-r--r-- | src/configoptions.cpp | 36 |
1 files changed, 25 insertions, 11 deletions
diff --git a/src/configoptions.cpp b/src/configoptions.cpp index 8522389..4fdaf90 100644 --- a/src/configoptions.cpp +++ b/src/configoptions.cpp @@ -45,7 +45,9 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "PROJECT_BRIEF", - "Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short." + "Using the PROJECT_BRIEF tag one can provide an optional one line description\n" + "for a project that appears at the top of each page and should give viewer\n" + "a quick idea about the purpose of the project. Keep the description short." ); //---- cs = cfg->addString( @@ -616,8 +618,11 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "STRICT_PROTO_MATCHING", - "If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a\n" - "match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen\n" + "If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to\n" + "do proper type resolution of all parameters of a function it will reject a\n" + "match between the prototype and the implementation of a member function even\n" + "if there is only one candidate or it is obvious which candidate to choose\n" + "by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen\n" "will still accept a match between prototype and implementation in such cases.", FALSE ); @@ -1114,7 +1119,13 @@ void addConfigOptions(Config *cfg) "HTML_HEADER", "The HTML_HEADER tag can be used to specify a personal HTML header for\n" "each generated HTML page. If it is left blank doxygen will generate a\n" - "standard header." + "standard header. Note that when using a custom header you are responsible\n" + "for the proper inclusion of any scripts and style sheets that doxygen\n" + "needs, which is dependent on the configuration options used.\n" + "It is adviced to generate a default header using \"doxygen -w html\n" + "header.html footer.html stylesheet.css YourConfigFile\" and then modify\n" + "that header. Note that the header is subject to change so you typically\n" + "have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW!" ); cs->setWidgetType(ConfigString::File); cs->addDependency("GENERATE_HTML"); @@ -1426,9 +1437,10 @@ void addConfigOptions(Config *cfg) //---- ci = cfg->addInt( "ENUM_VALUES_PER_LINE", - "This tag can be used to set the number of enum values (range [0,1..20])\n" - "that doxygen will group on one line in the generated HTML documentation.\n" - "Note that a value of 0 will completely suppress the enum values from appearing in the overview section.", + "The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values\n" + "(range [0,1..20]) that doxygen will group on one line in the generated HTML\n" + "documentation. Note that a value of 0 will completely suppress the enum\n" + "values from appearing in the overview section.", 0,20,4 ); ci->addDependency("GENERATE_HTML"); @@ -1510,7 +1522,8 @@ void addConfigOptions(Config *cfg) "HTML output directory using the MATHJAX_RELPATH option. The destination\n" "directory should contain the MathJax.js script. For instance, if the mathjax\n" "directory is located at the same level as the HTML output directory, then\n" - "MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing\n" + "MATHJAX_RELPATH should be ../mathjax. The default value points to the\n" + "mathjax.org site, so you can quickly see the result without installing\n" "MathJax, but it is strongly recommended to install a local copy of MathJax\n" "before deployment." ); @@ -1914,7 +1927,7 @@ void addConfigOptions(Config *cfg) cb = cfg->addBool( "SEARCH_INCLUDES", "If the SEARCH_INCLUDES tag is set to YES (the default) the includes files\n" - "in the INCLUDE_PATH (see below) will be search if a #include is found.", + "pointed to by INCLUDE_PATH will be searched when a #include is found.", TRUE ); cb->addDependency("ENABLE_PREPROCESSING"); @@ -1954,7 +1967,8 @@ void addConfigOptions(Config *cfg) "If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then\n" "this tag can be used to specify a list of macro names that should be expanded.\n" "The macro definition that is found in the sources will be used.\n" - "Use the PREDEFINED tag if you want to use a different macro definition that overrules the definition found in the source code." + "Use the PREDEFINED tag if you want to use a different macro definition that\n" + "overrules the definition found in the source code." ); cl->addDependency("ENABLE_PREPROCESSING"); //---- @@ -2213,7 +2227,7 @@ void addConfigOptions(Config *cfg) ce = cfg->addEnum( "DOT_IMAGE_FORMAT", "The DOT_IMAGE_FORMAT tag can be used to set the image format of the images\n" - "generated by dot. Possible values are png, svg, gif or svg.\n" + "generated by dot. Possible values are svg, png, jpg, or gif.\n" "If left blank png will be used.", "png" ); |