diff options
| author | Dimitri van Heesch <dimitri@stack.nl> | 2013-08-04 10:06:25 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <dimitri@stack.nl> | 2013-08-04 10:06:25 (GMT) |
| commit | 397c31a2d64173c0dc50567896fee378bea2fca0 (patch) | |
| tree | 97223fded40781fcc36cc8fbf4b51b3fe1fc896d /src | |
| parent | 66d184ce7e93d0c2b27fbb034180bebdbf1c26a1 (diff) | |
| download | Doxygen-397c31a2d64173c0dc50567896fee378bea2fca0.zip Doxygen-397c31a2d64173c0dc50567896fee378bea2fca0.tar.gz Doxygen-397c31a2d64173c0dc50567896fee378bea2fca0.tar.bz2 | |
Bug 691830 - Logical confusion with DISABLE_INDEX and GENERATE_TREEVIEW
Diffstat (limited to 'src')
| -rw-r--r-- | src/config.xml | 11 | ||||
| -rw-r--r-- | src/configoptions.cpp | 10 |
2 files changed, 11 insertions, 10 deletions
diff --git a/src/config.xml b/src/config.xml index d73a26c..1630c6b 100644 --- a/src/config.xml +++ b/src/config.xml @@ -2122,9 +2122,9 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. might be necessary to disable the index and replace it with your own. The \c DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top of each HTML page. A value of \c NO enables the index and the - value \c YES disables it. Since the tabs have the same information as the - navigation tree you can set this option to \c NO if you already set - \ref cfg_generate_treeview "GENERATE_TREEVIEW" to \c YES. + value \c YES disables it. Since the tabs in the index contain the same + information as the navigation tree, you can set this option to \c YES if + you also set \ref cfg_generate_treeview "GENERATE_TREEVIEW" to \c YES. ]]> </docs> </option> @@ -2145,8 +2145,9 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. example that shows how to put an image at the root of the tree instead of the \ref cfg_project_name "PROJECT_NAME". - Since the tree basically has the same information as the tab index you - could consider to set \ref cfg_disable_index "DISABLE_INDEX" to \c NO when enabling this option. + Since the tree basically has the same information as the tab index, you could + consider setting \ref cfg_disable_index "DISABLE_INDEX" to \c YES when + enabling this option. ]]> </docs> </option> diff --git a/src/configoptions.cpp b/src/configoptions.cpp index 1dc4a06..26de2fd 100644 --- a/src/configoptions.cpp +++ b/src/configoptions.cpp @@ -1761,9 +1761,9 @@ void addConfigOptions(Config *cfg) "be necessary to disable the index and replace it with your own. The\n" "DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top\n" "of each HTML page. A value of NO enables the index and the value YES disables\n" - "it. Since the tabs have the same information as the navigation tree you can\n" - "set this option to NO if you already set GENERATE_TREEVIEW to YES.Default\n" - "value: NO.\n" + "it. Since the tabs in the index contain the same information as the navigation\n" + "tree, you can set this option to YES if you also set GENERATE_TREEVIEW to\n" + "YES.Default value: NO.\n" "\n" "This tag requires that the tag GENERATE_HTML is set to YES.", FALSE @@ -1782,8 +1782,8 @@ void addConfigOptions(Config *cfg) "further fine-tune the look of the index. As an example, the default style\n" "sheet generated by doxygen has an example that shows how to put an image at\n" "the root of the tree instead of the PROJECT_NAME. Since the tree basically has\n" - "the same information as the tab index you could consider to set DISABLE_INDEX\n" - "to NO when enabling this option.Default value: NO.\n" + "the same information as the tab index, you could consider setting\n" + "DISABLE_INDEX to YES when enabling this option.Default value: NO.\n" "\n" "This tag requires that the tag GENERATE_HTML is set to YES.", FALSE |