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

Documentation for CLASS_DIAGRAMS option is misleading (Origin: bugzilla #571014) #3261

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.5.8 on platform Other
Assigned to: Dimitri van Heesch

On 2009-02-09 03:03:38 +0000, Craig Scott wrote:

Documentation
Section: tooltip for the CLASS_DIAGRAMS option
"... Note that this option is superseded by the HAVE_DOT option below. This is only a fallback. ..."

Correct version:

Other information:
This option is not really superseded by the HAVE_DOT option. If CLASS_DIAGRAMS is set to "no", then no class diagrams are generated by dot for each individual class page even if HAVE_DOT is set to true. The documentation as it stands leads the user to believe that CLASS_DIAGRAMS is useless if HAVE_DOT is set to "yes", but in fact CLASS_DIAGRAMS still controls whether or not those class diagrams are shown on the individual class pages.

On 2009-02-09 03:05:37 +0000, Craig Scott wrote:

Actually, this might be a bug in how CLASS_GRAPH and CLASS_DIAGRAMS are handled when HAVE_DOT is true. In my case, I only get the individual class inheritance diagrams on each class page if CLASS_DIAGRAMS is checked in doxywizard, even though the CLASS_GRAPH documentation says CLASS_GRAPH forces CLASS_DIAGRAMS to NO.

On 2010-09-10 13:03:40 +0000, Stein Somers wrote:

Status unconfirmed? Well, I can confirm the documentation for CLASS_DIAGRAMS has mislead me to turn it off and into a wild goose chase for many hours.

On 2010-09-10 21:52:19 +0000, Dimitri van Heesch wrote:

Agreed, I propose the following new text:

"If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
or super classes. Setting the tag to NO turns the diagrams off. Note that
this option also works with HAVE_DOT disabled, but it is recommended to
install and use dot, since it yields more powerful graphs.
"

and will also make HAVE_DOT=YES and CLASS_GRAPH=YES generate class diagrams regardless of the CLASS_DIAGRAMS setting (which was actually the original intention).

On 2010-10-09 08:19:48 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.2. 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