Skip to content

ci: enable doxygen check on noble #740

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

Draft
wants to merge 3 commits into
base: gz-physics8
Choose a base branch
from

Conversation

scpeters
Copy link
Member

🦟 Bug fix

Part of gazebo-tooling/release-tools#1222

Summary

Other packages have doxygen checking enabled, so try it here too

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • 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 and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

@scpeters scpeters added good first issue Good for newcomers help wanted Extra attention is needed labels May 2, 2025
@scpeters
Copy link
Member Author

scpeters commented May 2, 2025

this currently has the following doxygen complaints to be fixed:

warning: source '/github/workspace/build/libgz-physics-bullet-featherstone-plugin.so' is not a readable file or directory... skipping.
  warning: source '/github/workspace/build/libgz-physics-dartsim-plugin.so' is not a readable file or directory... skipping.
  warning: source '/github/workspace/build/libgz-physics-bullet-plugin.so' is not a readable file or directory... skipping.
  warning: source '/github/workspace/build/libgz-physics-tpe-plugin.so' is not a readable file or directory... skipping.
  warning: source '/github/workspace/build/libgz-physics-bullet-featherstone-plugin.so' is not a readable file or directory... skipping.
  warning: source '/github/workspace/build/libgz-physics-dartsim-plugin.so' is not a readable file or directory... skipping.
  warning: source '/github/workspace/build/libgz-physics-bullet-plugin.so' is not a readable file or directory... skipping.
  warning: source '/github/workspace/build/libgz-physics-tpe-plugin.so' is not a readable file or directory... skipping.
  /github/workspace/include/gz/physics/BoxShape.hh:55: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/include/gz/physics/CapsuleShape.hh:61: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/include/gz/physics/ConeShape.hh:63: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/include/gz/physics/CylinderShape.hh:61: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/include/gz/physics/EllipsoidShape.hh:55: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/include/gz/physics/FixedJoint.hh:63: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/include/gz/physics/FreeGroup.hh:102: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/include/gz/physics/FreeJoint.hh:56: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/include/gz/physics/PlaneShape.hh:71: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/include/gz/physics/PrismaticJoint.hh:63: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/include/gz/physics/RevoluteJoint.hh:68: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/include/gz/physics/SphereShape.hh:54: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/heightmap/include/gz/physics/heightmap/HeightmapShape.hh:60: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/mesh/include/gz/physics/mesh/MeshShape.hh:67: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
  /github/workspace/tutorials/01_intro.md:23: warning: image file img/gz-libraries.png is not found in IMAGE_PATH: assuming external image.
  /github/workspace/tutorials/02_installation.md:220: warning: unable to resolve reference to 'source-install' for \ref command
  /github/workspace/tutorials/06-physics-simulation-concepts.md:79: warning: image file img/diff_drive_link.gif is not found in IMAGE_PATH: assuming external image.
  /github/workspace/tutorials/06-physics-simulation-concepts.md:92: warning: image file img/diff_drive_collision.gif is not found in IMAGE_PATH: assuming external image.
  /github/workspace/tutorials/06-physics-simulation-concepts.md:129: warning: image file img/lift_drag_torque.gif is not found in IMAGE_PATH: assuming external image.
  /github/workspace/tutorials/06-physics-simulation-concepts.md:156: warning: image file img/buoyancy.gif is not found in IMAGE_PATH: assuming external image.
  /github/workspace/tutorials/06-physics-simulation-concepts.md:183: warning: image file img/pendulum.gif is not found in IMAGE_PATH: assuming external image.
  /github/workspace/tutorials/06-physics-simulation-concepts.md:221: warning: image file img/hover.gif is not found in IMAGE_PATH: assuming external image.
  /github/workspace/tutorials/08-implementing-a-custom-feature.md:68: warning: unable to resolve reference to 'gz::physics::FindFreeGroupFeature' for \ref command
  /github/workspace/tutorials/08-implementing-a-custom-feature.md:106: warning: unable to resolve reference to 'gz::physics::dartsim::RetrieveWorld' for \ref command
  /github/workspace/tutorials/08-implementing-a-custom-feature.md:150: warning: unable to resolve reference to 'gz::physics::Feature::Entity::Interface' for \ref command
  /github/workspace/tutorials/09_use_custom_engine.md:14: warning: unable to resolve reference to 'implementcustomfeature' for \ref command
  /github/workspace/tutorials/09_use_custom_engine.md:46: warning: unable to resolve reference to 'implementcustomfeature' for \ref command
  /github/workspace/tutorials/09_use_custom_engine.md:96: warning: unable to resolve reference to 'implementphysicsplugin' for \ref command
  /github/workspace/tutorials/09_use_custom_engine.md:134: warning: unable to resolve reference to 'gz::physics::tpelib::Base' for \ref command
  /github/workspace/tutorials/09_use_custom_engine.md:149: warning: unable to resolve reference to 'gz::physics::tpelib::World' for \ref command
  /github/workspace/tutorials/09_use_custom_engine.md:150: warning: unable to resolve reference to 'gz::physics::tpelib::Base::AddWorld' for \ref command
  /github/workspace/include/gz/physics/CanReadData.hh:95: warning: unable to resolve reference to 'ReadCompilationFail' for \ref command
  /github/workspace/include/gz/physics/CanWriteData.hh:100: warning: unable to resolve reference to 'WriteCompilationFail' for \ref command

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed 🏛️ ionic Gazebo Ionic 🪵 jetty Gazebo Jetty
Projects
Status: Inbox
Development

Successfully merging this pull request may close these issues.

1 participant