This repository has been archived by the owner on Jul 8, 2022. It is now read-only.
A small doxygen improvement - take version from cmake #436
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
bourtemb
reviewed
Feb 20, 2018
There was a problem hiding this comment.
This PR is a good idea. Thanks!
I would even go further by generating the HTML documentation somewhere under the CMAKE_CURRENT_BINARY_DIR.
This could be done by changing line:
HTML_OUTPUT = ../doc_html
with
HTML_OUTPUT = ${CMAKE_CURRENT_BINARY_DIR}/../doc_html
in Doxyfile.in.
This would generate the HTML doc under <current_build_dir>/cppapi/doc_html directory for instance without polluting the source directory.
|
Agree |
bourtemb
reviewed
Feb 20, 2018
cppapi/doxygen/Doxyfile.in
Outdated
| @@ -51,14 +51,14 @@ PROJECT_BRIEF = | |||
| # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo | |||
| # to the output directory. | |||
|
|
|||
| PROJECT_LOGO = ../doxygen/logo.jpg | |||
| PROJECT_LOGO = ${PROJECT_SOURCE_DIR}/doxygen/logo.jpg | |||
There was a problem hiding this comment.
${PROJECT_SOURCE_DIR}/doxygen/logo.jpg => ${PROJECT_SOURCE_DIR}/cppapi/doxygen/logo.jpg
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.
subj