Skip to content
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

issue #7273 dot called even when HAVE_DOT is NO #8663

Merged
merged 1 commit into from
Aug 17, 2021

Conversation

albert-github
Copy link
Collaborator

Guarded the \dot and \dotfile against HAVE_DOT not set.

(PlantUML was already guarded by means of PLANTUML_JAR_PATH)

Example: example.tar.gz

Guarded the `\dot` and `\dotfile` in case `HAVE_DOT` is not set.

(PlantUML was already guarded by means of `PLANTUML_JAR_PATH`)
@doxygen doxygen merged commit 9c2b8ae into doxygen:master Aug 17, 2021
@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Aug 17, 2021
@albert-github albert-github deleted the feature/issue_7273 branch August 17, 2021 13:48
@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Aug 18, 2021
albert-github added a commit to albert-github/doxygen that referenced this pull request Aug 20, 2021
Since  the issue doxygen#7273  and pull request doxygen#8663 the setting `HAVE_DOT` was required when one wants to incorporate a "dot" type of graph, though this interferes with the Inheritance usage, especially when one wants to have a textual" list.
There were a number of settings etc. involved:
- `CLASS_GRAPH`
- `CLASS_DIAGRAMS`
- `HAVE_DOT`

and the layout setting
- `<inheritancegraph visible="$CLASS_GRAPH"/>`

With this patch the following scheme has been implemented:
```
HAVE_DOT, CLASS_GRAPH,   class diagram output
================================================================
NO,       NO             nothing shown (expected)
NO,       YES            built-in diagram
NO,       TEXT           text link
NO,       GRAPH          built-in diagram (same as YES)
YES,      NO             nothing shown (expected, HAVE_DOT can be used for other diagrams and \dot)
YES,      YES            dot generated diagram
YES,      TEXT           text link
YES,      GRAPH          dot generated diagram (same as YES)
```
The setting `CLASS_DIAGRAMS` is not necessary and has been declared obsolete.
albert-github added a commit to albert-github/cgal that referenced this pull request Aug 24, 2021
In the BGL package we get a warning like:
```
/home/cgal-testsuite/cgal_doc_build/CGAL-5.4-Ic-33/doc/BGL/PackageDescription.txt:29: warning: ignoring \dot command because HAVE_DOT is not set
```
The BGL package uses the `\dot` and has now to use the setting `HAVE_DOT=YES` to see the dot image.
Till now this went OK as the `\dot` command didn't look at the setting of the `HAVE_DOT` setting in the Doxyfile, though by the issue doxygen/doxygen#7273 and the pull request doxygen/doxygen#8663 it is now required that `HAVE_DOT` is set.
The idea of setting `HAVE_DOT` for the BGL project removed the warning (and shows the figure again) though has also as side effect that the inheritance graphs are shown. Until now CGAL shows for the inheritance just the text version.

Doxygen now has for the `CLASS_GRAPH` setting the possibility `TEXT` that does exactly what is required.

Due to the general setting of `HAVE_DOT` also the not needed `graph_legend` was generated and some `INCLUDE_GRAPH`s, by setting this to `NO ` these are no suppressed as well.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants