gazebosim / gz-cmake

A set of CMake modules that are used by the C++-based Gazebo projects.
https://gazebosim.org/libs/cmake
Apache License 2.0
27 stars 31 forks source link

Update doxygen file #276

Closed chapulina closed 2 years ago

chapulina commented 2 years ago

🦟 Bug fix

Summary

I noticed warnings like this while building on Jammy:

warning: Tag 'TCL_SUBST' at line 237 of file '/home/chapulina/dev_jammy/ws_garden/build/gz-fuel_tools8/api_tagfile.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1044 of file '/home/chapulina/dev_jammy/ws_garden/build/gz-fuel_tools8/api_tagfile.dox' has becom
e obsolete.                                                                                                                                          To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"                        
warning: Tag 'TCL_SUBST' at line 237 of file '/home/chapulina/dev_jammy/ws_garden/build/gz-fuel_tools8/api.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"                        
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1044 of file '/home/chapulina/dev_jammy/ws_garden/build/gz-fuel_tools8/api.dox' has become obsole
te.                                                                                                                                         
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"

How well do we want support people generating docs locally? Ultimately, what really matters are the docs we upload to https://gazebosim.org through our nightly uploads. As long as we support that use case well, I think the least we should do for other users is:


So I ran doxygen -u doc/doxygen/api.in on Focal (which has doxygen version 1.8.17), and the file was automatically updated. I manually modified a few things that seemed to have been explicitly set by us.

My goals are to:

Just opening this for visibility for now.

Checklist

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.

πŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”ΈπŸ”Έ

chapulina commented 2 years ago

I actually just realized that our docs don't build on Jammy for gz-sim. Commenting out ADDITIONAL_INPUT_DIRS fixes the build. Something to look into. It's probably related to the doxygen version.

chapulina commented 2 years ago

I actually just realized that our docs don't build on Jammy for gz-sim.

Ok, I remembered now that @j-rivero had run into this, here's the issue: