Skip to content

Add Doxygen documentation checks to CI#225

Merged
chapulina merged 3 commits intoign-math6from
chapulina/6/doxygen_ci
Aug 19, 2021
Merged

Add Doxygen documentation checks to CI#225
chapulina merged 3 commits intoign-math6from
chapulina/6/doxygen_ci

Conversation

@chapulina
Copy link
Copy Markdown
Contributor

🎉 New feature

Summary

Requires gazebo-tooling/action-gz-ci#30

Also fixed the existing warnings.

Test it

The checks can be run locally by:

cd <build folder>
make doc
bash <(curl -s https://raw.githubusercontent.com/ignitionrobotics/ign-cmake/ign-cmake2/tools/doc_check.sh)

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge

🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸

Signed-off-by: Louise Poubel <louise@openrobotics.org>
Signed-off-by: Louise Poubel <louise@openrobotics.org>
@chapulina chapulina added the documentation Improvements or additions to documentation label Aug 19, 2021
@chapulina chapulina requested a review from j-rivero August 19, 2021 01:59
@chapulina chapulina requested a review from scpeters as a code owner August 19, 2021 01:59
@github-actions github-actions bot added 🏢 edifice Ignition Edifice 🏯 fortress Ignition Fortress 🏰 citadel Ignition Citadel 🔮 dome Ignition Dome labels Aug 19, 2021
@codecov
Copy link
Copy Markdown

codecov bot commented Aug 19, 2021

Codecov Report

Merging #225 (fc57a24) into ign-math6 (2c4fa24) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           ign-math6     #225   +/-   ##
==========================================
  Coverage      99.21%   99.21%           
==========================================
  Files             65       65           
  Lines           6089     6089           
==========================================
  Hits            6041     6041           
  Misses            48       48           
Impacted Files Coverage Δ
include/ignition/math/Cylinder.hh 100.00% <ø> (ø)
include/ignition/math/Ellipsoid.hh 100.00% <ø> (ø)

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 2c4fa24...fc57a24. Read the comment docs.

Signed-off-by: Louise Poubel <louise@openrobotics.org>
@chapulina chapulina enabled auto-merge (squash) August 19, 2021 15:39
@chapulina chapulina merged commit cf5e33c into ign-math6 Aug 19, 2021
@chapulina chapulina deleted the chapulina/6/doxygen_ci branch August 19, 2021 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🏰 citadel Ignition Citadel documentation Improvements or additions to documentation 🔮 dome Ignition Dome 🏢 edifice Ignition Edifice 🏯 fortress Ignition Fortress

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants