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.

Sign up for GitHub

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

Jump to bottom

[20413] Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 #4376

Merged
merged 1 commit into from
Feb 16, 2024
Merged

[20413] Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 #4376

merged 1 commit into from
Feb 16, 2024

Conversation

Mario-DL
Copy link
Member

@Mario-DL Mario-DL commented Feb 12, 2024 •
edited by JesusPoderoso
Loading

Description

This PR fixes some minor typos and declares some extra groups into the doxygen_modules.h file that fixes a compilation warning stating that the @ingroup doxygen macros did not point to a valid group.

Before doxygen 1.10.0 it was not considered a warning, but, as we define WARN_AS_ERROR to YES in the doxyfile.in, we fail to compile with with doxygen >= 1.10.0 since it is treated as a warning henceforth.

Two considerations:

  • This PR does NOT upgrade the doxyfile.in to 1.10.0 yet, so building with doxygen 1.10.0 and -DBUILD_DOCUMENTATION=ON outputs a bunch of info messages complaining that some of the configuration options are obsolete, but now, the compilation finishes successfully.
  • Some of the fixes affect the /types directory which is going to be deprecated with the new XTypes refactor.

@Mergifyio backport 2.12.x 2.11.x 2.10.x 2.6.x

Fixes #4370

Contributor Checklist

  • Commit messages follow the project guidelines.
  • N/A 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 Changes are ABI compatible.
    -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.
  • 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.

@Mario-DL Mario-DL added the no-test Skip CI tests if PR marked with this label label Feb 12, 2024
@Mario-DL Mario-DL added this to the v2.13.3 milestone Feb 12, 2024
@Mario-DL
Refs #20413: Fix @ingroups warnings
46c2722 
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
@Mario-DL Mario-DL mentioned this pull request Feb 12, 2024
Merged
@Mario-DL
Copy link
Member Author

@richiprosima please test this

JesusPoderoso
JesusPoderoso approved these changes Feb 13, 2024
View reviewed changes
Copy link
Contributor

@JesusPoderoso JesusPoderoso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@JesusPoderoso
Copy link
Contributor

@richiprosima please test mac

1 similar comment
@Mario-DL
Copy link
Member Author

@richiprosima please test mac

@EduPonz
Copy link

EduPonz commented Feb 16, 2024

@Mergifyio backport 2.12.x 2.11.x 2.10.x 2.6.x

@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 16, 2024 •
edited
Loading

backport 2.12.x 2.11.x 2.10.x 2.6.x

✅ Backports have been created

@EduPonz EduPonz merged commit dcf1c62 into master Feb 16, 2024
13 of 18 checks passed
@EduPonz EduPonz deleted the fix/doxygen-warnings branch February 16, 2024 08:35
mergify bot pushed a commit that referenced this pull request Feb 16, 2024
@Mario-DL @mergify
Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 (#…
afc7bea 
…4376)

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
(cherry picked from commit dcf1c62)
@mergify mergify bot mentioned this pull request Feb 16, 2024
Merged
mergify bot pushed a commit that referenced this pull request Feb 16, 2024
@Mario-DL @mergify
Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 (#…
15d43dd 
…4376)

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
(cherry picked from commit dcf1c62)

# Conflicts:
#	include/fastrtps/types/AnnotationParameterValue.h
This was referenced Feb 16, 2024
Closed
Merged
@mergify mergify bot mentioned this pull request Feb 16, 2024
Merged
Mario-DL added a commit that referenced this pull request Feb 23, 2024
@Mario-DL
Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 (#…
9c115d6 
…4376)

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
EduPonz pushed a commit that referenced this pull request Feb 27, 2024
@mergify @Mario-DL
Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 (#…
b6d5dc2 
…4376) (#4390)

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
(cherry picked from commit dcf1c62)

Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com>
EduPonz pushed a commit that referenced this pull request Feb 29, 2024
@mergify @Mario-DL
Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 (#…
a0b3633 
…4376) (#4393)

* Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 (#4376)

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

* Linter

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

---------

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com>
Co-authored-by: Mario Dominguez <mariodominguez@eprosima.com>
Mario-DL added a commit that referenced this pull request Mar 7, 2024
@Mario-DL
Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 (#…
898e858 
…4376)

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
MiguelCompany pushed a commit that referenced this pull request Mar 8, 2024
@mergify @Mario-DL
Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 (#…
c263d10 
…4376) (#4392)

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com>
cferreiragonz pushed a commit that referenced this pull request Mar 11, 2024
@mergify @Mario-DL @cferreiragonz
Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 (#…
f49c0db 
…4376) (#4392)

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JesusPoderoso JesusPoderoso JesusPoderoso approved these changes

Assignees
No one assigned
Labels
no-test Skip CI tests if PR marked with this label
Projects
None yet
Milestone
v2.13.3
Development

Successfully merging this pull request may close these issues.

API doc generation fails with doxygen >= 1.10.0
3 participants
@Mario-DL @JesusPoderoso @EduPonz