Skip to content
This repository was archived by the owner on Jul 8, 2022. It is now read-only.

A small doxygen improvement - take version from cmake#436

Merged
Ingvord merged 3 commits intotango-9-ltsfrom
improve-doxygen
Feb 20, 2018
Merged

A small doxygen improvement - take version from cmake#436
Ingvord merged 3 commits intotango-9-ltsfrom
improve-doxygen

Conversation

@Ingvord
Copy link
Copy Markdown
Member

@Ingvord Ingvord commented Feb 20, 2018

subj

@Ingvord Ingvord requested a review from bourtemb February 20, 2018 13:23
@Ingvord Ingvord self-assigned this Feb 20, 2018
Copy link
Copy Markdown
Member

@bourtemb bourtemb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@Ingvord
Copy link
Copy Markdown
Member Author

Ingvord commented Feb 20, 2018

Agree

Comment thread cppapi/doxygen/Doxyfile.in Outdated
# to the output directory.

PROJECT_LOGO = ../doxygen/logo.jpg
PROJECT_LOGO = ${PROJECT_SOURCE_DIR}/doxygen/logo.jpg
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

${PROJECT_SOURCE_DIR}/doxygen/logo.jpg => ${PROJECT_SOURCE_DIR}/cppapi/doxygen/logo.jpg

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True!

Copy link
Copy Markdown
Member

@bourtemb bourtemb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants