Generate graphs, when creating Doxygen documentation#1872
Merged
jan-cerny merged 2 commits intoOpenSCAP:maint-1.3from Aug 3, 2022
Merged
Generate graphs, when creating Doxygen documentation#1872jan-cerny merged 2 commits intoOpenSCAP:maint-1.3from
jan-cerny merged 2 commits intoOpenSCAP:maint-1.3from
Conversation
evgenyz
reviewed
Jul 19, 2022
Contributor
|
@jan-cerny What do you thing about diagrams in our API docs? |
If we enable documentation and CMake finds Doxygen and 'dot' in path, diagrams and graphs will be created. CMake searches for 'dot' at the same time as Doxygen. 'dot' is a tool found in graphviz.
Some advantages over png is file size and scalability. As far as I know, it's only IE 9+ that has compatibility issues with svg files.
Member
|
@evgenyz They look like they won't help you much, you would need some more knowledgable diagram, that would have to be created manually I think. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When building documentation with Doxygen, and
dotis found, generate diagrams and graphs.I changed the image format to svg, for smaller file size and better scaling.
dotis normally found ingraphvizpackage and is entirely optional to install.