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

Fix namespace and class links in documentation references that use namespace gz #2385

Merged
merged 1 commit into from
Apr 25, 2024

Conversation

azeey
Copy link
Contributor

@azeey azeey commented Apr 25, 2024

🦟 Bug fix

Summary

The gz namespace is not recognized by doxygen enough for it to autogenerate links to inner namespaces and classes. For example, \ref gz::sim::systems or simply gz::sim::systems don't link to the namespace documentation. You'd have to use ignition::gazebo::systems instead. I was hoping there was a more clever solution that would allow all gz:: refs to work automatically, but I was not able to find one, so this is a compromise to fix the landing page for ign-gazebo6 (https://gazebosim.org/api/sim/6)

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.

…mespace `gz`

The `gz` namespace is not recognized by doxygen enough for it to
autogenerate links to inner namespaces and classes. For example, `\ref
gz::sim::systems` or simply `gz::sim::systems` don't link to the
namespace documentation. You'd have to use `ignition::gazebo::systems` instead. I was hoping there
was a more clever solution that would allow all `gz::` refs to work
automatically, but I was not able to find one, so this is a compromise
to fix the landing page for ign-gazebo6 (https://gazebosim.org/api/sim/6)

Signed-off-by: Addisu Z. Taddese <[email protected]>
@azeey azeey requested a review from mjcarroll as a code owner April 25, 2024 20:28
@github-actions github-actions bot added the 🏯 fortress Ignition Fortress label Apr 25, 2024
@azeey azeey merged commit fb3f3d4 into gazebosim:ign-gazebo6 Apr 25, 2024
9 of 11 checks passed
@azeey azeey deleted the fix_doxygen_links branch April 25, 2024 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏯 fortress Ignition Fortress
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants