After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 571014 - Documentation for CLASS_DIAGRAMS option is misleading
Documentation for CLASS_DIAGRAMS option is misleading
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: documentation
1.5.8
Other All
: Normal minor
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2009-02-09 03:03 UTC by Craig Scott
Modified: 2010-10-09 08:19 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Craig Scott 2009-02-09 03:03:38 UTC
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.
Comment 1 Craig Scott 2009-02-09 03:05:37 UTC
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.
Comment 2 Stein Somers 2010-09-10 13:03:40 UTC
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.
Comment 3 Dimitri van Heesch 2010-09-10 21:52:19 UTC
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).
Comment 4 Dimitri van Heesch 2010-10-09 08:19:48 UTC
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.