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 doxygen deprecation warns. #333

Merged
merged 1 commit into from
Apr 14, 2023

Conversation

bperseghetti
Copy link
Member

@bperseghetti bperseghetti commented Jan 14, 2023

Used doxygen -u to fix doxygen warns during colcon builds.

Signed-off-by: Benjamin Perseghetti [email protected]

🦟 Bug fix

Fixes #332

Doxygen no longer throws deprecation/obsolete warnings.

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.

@github-actions github-actions bot added the 🌱 garden Ignition Garden label Jan 14, 2023
Copy link
Contributor

@azeey azeey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of the newly added parameters cause warnings on Ubuntu 20.04:

warning: ignoring unsupported tag 'PYTHON_DOCSTRING' at line 226, file /home/addisu/ws/garden/build/gz-math7/api.dox
warning: ignoring unsupported tag 'NUM_PROC_THREADS' at line 464, file /home/addisu/ws/garden/build/gz-math7/api.dox
warning: ignoring unsupported tag 'RESOLVE_UNNAMED_PARAMS' at line 534, file /home/addisu/ws/garden/build/gz-math7/api.dox
warning: ignoring unsupported tag 'CLANG_ADD_INC_PATHS' at line 1122, file /home/addisu/ws/garden/build/gz-math7/api.dox
warning: ignoring unsupported tag 'HTML_FORMULA_FORMAT' at line 1575, file /home/addisu/ws/garden/build/gz-math7/api.dox
warning: ignoring unsupported tag 'DOT_UML_DETAILS' at line 2405, file /home/addisu/ws/garden/build/gz-math7/api.dox
warning: ignoring unsupported tag 'DOT_WRAP_THRESHOLD' at line 2414, file /home/addisu/ws/garden/build/gz-math7/api.dox

I think it would be safe to just remove those parameters and let doxygen use the defaults.

@bperseghetti
Copy link
Member Author

I should mention I only ran this on 22.04. And it was to fix the colcon bugs/errors that I was getting from deprecation warns.

@bperseghetti
Copy link
Member Author

@azeey should this be focused/targeted for only 22.04 forward or does gz-cmake3 also apply to 20.04 as well?
Would a gz-camke4 make sense if there are enough difference between doxygen on 22.04 and 20.04?

@azeey
Copy link
Contributor

azeey commented Jan 23, 2023

gz-cmake3 needs to support both 20.04 and 22.04. I think removing the parameters that were causing the warnings and letting doxygen use the defaults should work for most cases. In general, we mostly use the doxgen defaults, so our configuration file could potentially be trimmed quite a bit, but I don't know if that's worth the effort.

Switching to gz-cmake4 would have quite the ripple effect, so I wouldn't go that route. If we really have a flag that should have different values for 20.04 vs 22.04, we might be able to address it with some cmake logic. But in this scenario, I don't think we even need that.

Signed-off-by: Benjamin Perseghetti <[email protected]>
@bperseghetti
Copy link
Member Author

@azeey seems to now fix my warn/errors in 22.04. Just removed COLS_IN_ALPHA_INDEX and TCL_SUBST

@azeey azeey merged commit 9894b39 into gazebosim:gz-cmake3 Apr 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌱 garden Ignition Garden
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Doxygen warn errors.
3 participants