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

[21144] Fix Doxygen errors for Doxygen versions prior to 1.8.19 #4896

Merged
merged 1 commit into from
Jun 5, 2024

Conversation

EduPonz
Copy link

@EduPonz EduPonz commented Jun 5, 2024

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 the param directive to be one of [in], [out], and [in,out], doxygen/doxygen#7881 introduced, among other things, the possibility to set the dir 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.

image

This has been addressed in:

The doxygen documentation is updated in:

Contributor Checklist

  • Commit messages follow the project guidelines.
  • The code follows the style guidelines of this project.
  • N/A: Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally
  • N/A: Any new/modified methods have been properly documented using Doxygen.
  • N/A: Any new configuration API has an equivalent XML API (with the corresponding XSD extension)
  • N/A: Changes are backport compatible: they do NOT break ABI nor change library core behavior.
  • N/A: Changes are API compatible.
  • N/A: New feature has been added to the versions.md file (if applicable).
  • N/A: New feature has been documented/Current behavior is correctly described in the documentation.
  • N/A: Applicable backports have been included in the description.

Reviewer Checklist

  • The PR has a milestone assigned.
  • The title and description correctly express the PR's purpose.
  • Check contributor checklist is correct.
  • Check CI results: changes do not issue any warning.
  • Check CI results: failing tests are unrelated with the changes.

@EduPonz EduPonz added the skip-ci Automatically pass CI label Jun 5, 2024
@EduPonz EduPonz requested a review from Mario-DL June 5, 2024 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-ci Automatically pass CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants