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

Added an option to include auto generated code in the ign_create_docs function #108

Merged
merged 1 commit into from
Aug 13, 2020

Conversation

ahcorde
Copy link
Contributor

@ahcorde ahcorde commented Aug 13, 2020

This PR is related with this issue gazebosim/gz-msgs#12

I have included a new argument called AUTOGENERATED_DOC to ign_create_docs. you can include a a directory of auto generated code in the Doxygen INPUT field.

For example, in the ign-msgs library:

ign_create_docs(
  API_MAINPAGE_MD "${CMAKE_BINARY_DIR}/api.md"
  TUTORIALS_MAINPAGE_MD "${CMAKE_BINARY_DIR}/tutorials.md"
  AUTOGENERATED_DOC "${CMAKE_BINARY_DIR}/include/ignition/msgs/"
  TAGFILES
    "${IGNITION-MATH_DOXYGEN_TAGFILE} = ${IGNITION-MATH_API_URL}"
)

@ahcorde ahcorde added the documentation Improvements or additions to documentation label Aug 13, 2020
@ahcorde ahcorde requested a review from mxgrey as a code owner August 13, 2020 11:33
@ahcorde ahcorde self-assigned this Aug 13, 2020
@github-actions github-actions bot added 🏰 citadel Ignition Citadel 📜 blueprint Ignition Blueprint 🔮 dome Ignition Dome labels Aug 13, 2020
@chapulina chapulina added the boost the docs Documentation deployment, usability and parity with classic label Aug 13, 2020
Copy link
Contributor

@chapulina chapulina left a comment

Choose a reason for hiding this comment

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

Simple and elegant ✨

@chapulina chapulina merged commit 220e990 into ign-cmake2 Aug 13, 2020
@chapulina chapulina deleted the ahcorde/doc/generated_code branch August 13, 2020 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📜 blueprint Ignition Blueprint boost the docs Documentation deployment, usability and parity with classic 🏰 citadel Ignition Citadel documentation Improvements or additions to documentation 🔮 dome Ignition Dome
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants