New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Logical confusion with DISABLE_INDEX and GENERATE_TREEVIEW (Origin: bugzilla #691830) #5035

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity minor in component documentation for ---
Reported in version 1.8.3 on platform Other
Assigned to: Dimitri van Heesch

On 2013-01-16 06:22:53 +0000, x29a wrote:

The default doxycfg template generated via

doxygen -g myTemplate.doxycfg

states the following guidance for the two mentioned tags:

The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)

at top of each HTML page. The value NO (the default) enables the index and

the value YES disables it. Since the tabs have the same information as the

navigation tree you can set this option to NO if you already set

GENERATE_TREEVIEW to YES.

DISABLE_INDEX = NO

The GENERATE_TREEVIEW tag is used to specify whether a tree-like index

structure should be generated to display hierarchical information.

If the tag value is set to YES, a side panel will be generated

containing a tree-like index structure (just like the one that

is generated for HTML Help). For this to work a browser that supports

JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).

Windows users are probably better off using the HTML help feature.

Since the tree basically has the same information as the tab index you

could consider to set DISABLE_INDEX to NO when enabling this option.

GENERATE_TREEVIEW = NO

I would understand it in the following way: If GENERATE_TREEVIEW is set to YES, the information provided by the index is already visible, therefore one could DISABLE the INDEX, by setting this tag to YES.

The adjusted comments would be:
'Since the tabs in the index contain the same information as the navigation tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.'

and

'Since the tree basically has the same information as the tab index, you could consider setting DISABLE_INDEX to YES when enabling this option.'

If this is a misconception or logical flaw on my side, feel free to just close this bug :)

On 2013-08-04 10:07:39 +0000, Dimitri van Heesch wrote:

Confirmed, docs were wrong and you were right.
Should be fixed in the next GIT update.

On 2013-08-23 15:04:52 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.5. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment