[20413] Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 #194
Conversation
This file contains 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
Mario-DL
force-pushed
the
fix/doxygen-warnings
branch
2 times, most recently
from
83e37f5
to
023231c
Compare
|
Build status:
|
|
Manual run launched here |
|
@Mergifyio rebase |
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
✅ Branch has been successfully rebased |
JesusPoderoso
force-pushed
the
fix/doxygen-warnings
branch
from
023231c
to
c489251
Compare
|
Build status:
|
EduPonz
pushed a commit
that referenced
this pull request
Feb 22, 2024
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
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.
The actual
utils/doxygen/doxygenfiles/mainpage.doxthat defines the main doxygen groups is not being loaded (see here), so, when compiling with recent versions ofdoxygen(>= 1.10.0) the@ingroupmacros complain that the doxygenFASTCDRAPIREFERENCEandEXCEPTIONMODULEgroups are not defined.This PR adds a
doxygen_modules.hheader underconfigthat declares the groups and solve the compilation warning with recent versions.A final consideration:
This PR does NOT upgrade the doxyfile.in to 1.10.0 yet, so building with
doxygen 1.10.0and-DBUILD_DOCUMENTATION=ONstill outputs a bunch of info messages complaining that some of the configuration options are obsolete, but now, the compilation finishes successfully.This PR is congruent with eProsima/Fast-DDS#4376.
Fixes #193