[21144] Fix Doxygen errors for Doxygen versions prior to 1.8.19 #4896
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.
Description
This PR fixes some Doxygen errors when generating the API reference with Doxygen versions prior to 1.8.19, as it is the case of Fast DDS docs RTD page, which is generated in Ubuntu 20.04 and therefore with Doxygen 1.8.17.
Although Doxygen documentation documents the
dir
attribute of theparam
directive to be one of[in]
,[out]
, and[in,out]
, doxygen/doxygen#7881 introduced, among other things, the possibility to set thedir
attribute to[in out]
, which #4746 introduced in several places.Mind that in the dev machines this "mistake" went undetected because of the use of Ubuntu 22.04 (Doxygen 1.9.1).
Also, even though an error when generating the Doxygen documentation makes Fast DDS docs build to fail when building it through CMake, the RTD generation is done within conf.py directly, and the return code of the subprocess is not checked, which makes the RTD documentation to finish the build but then show an error on the API reference as follows.
This has been addressed in:
The doxygen documentation is updated in:
dir
attribute within theparam
command doxygen/doxygen#10927Contributor Checklist
versions.md
file (if applicable).Reviewer Checklist