This repository has been archived by the owner on Aug 2, 2022. It is now read-only.
Automated doxygen generation #196 #497
Merged
Conversation
This file contains 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
Doxygen documentation now automatically generated if Doxygen is present. Default destination is the build directory docs/html folder. Destination may be customized with -DDOXY_DOC_DEST_DIR=/destination/path or editing the entry in ccmake/cmake-gui.
jgiszczak
force-pushed
the
automated-doxygen-generation-196
branch
from
52a357a to
dae9678
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Doxygen documentation now automatically generated if Doxygen is present. Default destination is the build directory
docs/htmlfolder. Destination may be customized with-DDOXY_DOC_DEST_DIR=/dest/pathor editing the entry in ccmake/cmake-gui.Previously generated docs have been removed from version control. They're all machine generated, and so should not be in git.
In the interests of keeping things simple for the community, this pull request includes facilities to always generate the documentation. Core developers who don't want to see the doxygen output in every build should follow the instructions at the end of
CMakeLists.txt.Currently the generated docs are not published anywhere. Perhaps Travis should do the publishing?