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

Included autogenerated code to the ign_create_docs function #76

Merged
merged 2 commits into from
Aug 14, 2020

Conversation

ahcorde
Copy link
Contributor

@ahcorde ahcorde commented Aug 13, 2020

This PR is related with this issue #12 and it depends on this other PR gazebosim/gz-cmake#108

It makes use of the new argument (AUTOGENERATED_DOC) to include the auto generated code.

Signed-off-by: ahcorde [email protected]

@ahcorde ahcorde added the documentation Improvements or additions to documentation label Aug 13, 2020
@ahcorde ahcorde requested a review from chapulina August 13, 2020 11:39
@ahcorde ahcorde requested a review from caguero as a code owner August 13, 2020 11:39
@ahcorde ahcorde self-assigned this Aug 13, 2020
@github-actions github-actions bot added the 🔮 dome Ignition Dome label 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.

Works for me!

I just noticed that the is_proto_enum functions ended up having more spotlight than they deserve in the classes.html page. That's because being global functions, they just show up as top-level.

Another thing I noticed, but it's outside the scope of this PR, is that the generated functions don't have doxygen documentation. This is definitely not something we need to handle now.

CMakeLists.txt Outdated Show resolved Hide resolved
@ahcorde ahcorde force-pushed the ahcorde/doc/autogenerated_code branch from d592a22 to d8d1d76 Compare August 14, 2020 07:18
@codecov
Copy link

codecov bot commented Aug 14, 2020

Codecov Report

Merging #76 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #76   +/-   ##
=======================================
  Coverage   85.69%   85.69%           
=======================================
  Files           7        7           
  Lines         797      797           
=======================================
  Hits          683      683           
  Misses        114      114           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6b4430a...d8d1d76. Read the comment docs.

@chapulina chapulina merged commit 424db1e into master Aug 14, 2020
@chapulina chapulina deleted the ahcorde/doc/autogenerated_code branch August 14, 2020 18:49
ahcorde added a commit that referenced this pull request Aug 18, 2020
ahcorde added a commit that referenced this pull request Aug 18, 2020
chapulina pushed a commit that referenced this pull request Aug 19, 2020
chapulina pushed a commit that referenced this pull request Aug 20, 2020
@chapulina chapulina mentioned this pull request Sep 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
boost the docs Documentation deployment, usability and parity with classic documentation Improvements or additions to documentation 🔮 dome Ignition Dome
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants