Fix Doxygen warnings - #1489
Open
tinko92 wants to merge 2 commits into
Open
Conversation
tinko92
requested review from
awulkiew,
barendgehrels and
vissarion
and
a lite review from Copilot
September 1, 2026 13:35
There was a problem hiding this comment.
🟢 Approval recommended
The changes are documentation/config focused and the remaining findings are minor text/typo issues with straightforward fixes.
Pull request overview
This PR updates Boost.Geometry Doxygen inputs/configuration to eliminate warnings during documentation builds, including fixing missing/incorrect Doxygen annotations and modernizing Doxyfile settings.
Changes:
- Added missing parameter documentation and corrected Doxygen alias usage to silence warnings.
- Converted an inline example to use
\snippetand added matching snippet markers in the example source. - Updated Doxygen configuration files and added missing group definitions used by
\ingrouptags.
File summaries
| File | Description |
|---|---|
| include/boost/geometry/util/normalize_spheroidal_coordinates.hpp | Adds missing \param exact documentation to address undocumented-parameter warnings. |
| include/boost/geometry/io/wkt/write.hpp | Switches example extraction to \snippet for cleaner Doxygen markup. |
| include/boost/geometry/geometries/polyhedral_surface.hpp | Fixes a Doxygen alias name for initializer-list constructor docs. |
| doc/index/Doxyfile | Updates Index-doc Doxygen configuration to newer format/options to reduce warnings. |
| doc/doxy/doxygen_input/sourcecode/doxygen_1.cpp | Adds snippet block markers corresponding to the \snippet reference. |
| doc/doxy/doxygen_input/groups/groups.hpp | Adds missing \defgroup entries to satisfy \ingroup usage. |
| doc/doxy/Doxyfile | Updates main BG Doxygen configuration, including alias formatting and newer defaults. |
Review details
Suppressed comments (1)
include/boost/geometry/util/normalize_spheroidal_coordinates.hpp:381
- Typo in parameter documentation: "coordindate" should be "coordinate".
\tparam Units The units of the coordindate system in the spheroid
\tparam CoordinateType The type of the coordinates
\param longitude Longitude
\param exact Whether to use exact antimeridian checks; if false, a relaxed tolerance is used
\ingroup utility
- Files reviewed: 7/7 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
barendgehrels
approved these changes
Sep 1, 2026
barendgehrels
left a comment
Collaborator
There was a problem hiding this comment.
👍 looks good to me! Thanks!
tinko92
force-pushed
the
doc/doxygen-fixes
branch
from
September 2, 2026 05:33
f63e6c7 to
0a83094
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR fixes warnings currently produced by doxygen when building the BG doc.
Some warnings were related to deprecated options. This is fixed with doxygen -u -s Doxyfile, which updates it to the newest version. I used Doxygen 1.14 for that, which seems to be used by the Boost release container. Unfortunately this is (imho) needlessly verbose and adds every available option with its default values. Where it added entire sections, I removed those. For the comments that looked manually written (e.g. explaining the role of HTML output for BG within Boost), I put them manually back in since doxygen removes all comments. Our CI uses Doxygen 1.9.8 from Ubuntu 24.04, so I removed the options added by 1.14 that produced warnings in doxygen 1.9.8.
One warning was about a syntax error in Alias for an unused alias. I removed all unused aliases.
Some warnings were related to missing groups (added) and missing parameter documentation (from an earlier PR of mine, also added).
PR is split into two commits because the first one should be neutral (not change the documentation output at all besides timestamps). To allow verifying that in review, I kept it in a separate commit.
Doxygen has an option to produce a non-zero exit code. My original intent was to fix the warnings, then enable that so the CI can warn about future drift. But since our documentation CI job does not necessarily use the same doxygen version as the Boost release image, I decided against it to avoid this causing problems in the future (e.g. Boost release updating to a future Doxygen version, then erroring on some obsolete option). We could consider adding some script to our documentation CI job that looks at the output and errors on warnings to avoid overlooking e.g. undocumented parameters like in my earlier PR.