Improved doxygen

[ahcorde]

Signed-off-by: ahcorde [email protected]

🎉 New feature

Summary

Improved doxygen and added CI linter

Test it

In the build directory run:

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
• 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

[codecov]

Codecov Report

Merging #389 (df489a6) into ign-rendering3 (99c08c5) will not change coverage.
The diff coverage is 60.00%.

@@               Coverage Diff               @@
##           ign-rendering3     #389   +/-   ##
===============================================
  Coverage           53.35%   53.35%           
===============================================
  Files                 131      131           
  Lines               12036    12036           
===============================================
  Hits                 6422     6422           
  Misses               5614     5614           

Impacted Files	Coverage Δ
include/ignition/rendering/Camera.hh	100.00% <ø> (ø)
include/ignition/rendering/Geometry.hh	100.00% <ø> (ø)
include/ignition/rendering/GpuRays.hh	0.00% <ø> (ø)
include/ignition/rendering/Light.hh	100.00% <ø> (ø)
include/ignition/rendering/Material.hh	100.00% <ø> (ø)
include/ignition/rendering/Mesh.hh	100.00% <ø> (ø)
include/ignition/rendering/RayQuery.hh	100.00% <ø> (ø)
include/ignition/rendering/RenderEngine.hh	100.00% <ø> (ø)
include/ignition/rendering/Scene.hh	0.00% <ø> (ø)
include/ignition/rendering/Storage.hh	25.00% <ø> (ø)
... and 11 more

---

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 99c08c5...df489a6. Read the comment docs.

[chapulina]

🚀