Skip to content

Fix doxygen to avoid errors in python bindings docstrings#6034

Merged
MiguelCompany merged 1 commit intomasterfrom
hotfix/warnings-as-errors
Sep 16, 2025
Merged

Fix doxygen to avoid errors in python bindings docstrings#6034
MiguelCompany merged 1 commit intomasterfrom
hotfix/warnings-as-errors

Conversation

@MiguelCompany
Copy link
Copy Markdown
Member

@MiguelCompany MiguelCompany commented Sep 16, 2025

Description

Fix format in doxygen doxumentation so it does not produce warnings in the Python docstrings

@Mergifyio backport 3.3.x 3.2.x

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
  • 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)
  • Changes are backport compatible: they do NOT break ABI nor change library core behavior.
  • Changes are API compatible.
  • N/A: New feature has been added to the versions.md file (if applicable).
  • 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.
  • If this is a critical bug fix, backports to the critical-only supported branches have been requested.
  • Check CI results: changes do not issue any warning.
  • Check CI results: failing tests are unrelated with the changes.

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
@MiguelCompany MiguelCompany added this to the v3.4.0 milestone Sep 16, 2025
@MiguelCompany MiguelCompany marked this pull request as ready for review September 16, 2025 12:31
@MiguelCompany MiguelCompany added the no-test Skip CI tests if PR marked with this label label Sep 16, 2025
@MiguelCompany MiguelCompany changed the title Fix doxygen to avoid errors in python bindings Fix doxygen to avoid errors in python bindings docstrings Sep 16, 2025
@MiguelCompany MiguelCompany requested review from richiprosima and removed request for richiprosima September 16, 2025 12:37
@github-actions github-actions bot added the ci-pending PR which CI is running label Sep 16, 2025
@MiguelCompany
Copy link
Copy Markdown
Member Author

@Mergifyio backport 3.3.x 3.2.x

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Sep 16, 2025

backport 3.3.x 3.2.x

✅ Backports have been created

Details

@MiguelCompany MiguelCompany merged commit 0488950 into master Sep 16, 2025
19 checks passed
@MiguelCompany MiguelCompany deleted the hotfix/warnings-as-errors branch September 16, 2025 15:20
mergify bot pushed a commit that referenced this pull request Sep 16, 2025
Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
(cherry picked from commit 0488950)
mergify bot pushed a commit that referenced this pull request Sep 16, 2025
Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
(cherry picked from commit 0488950)
MiguelCompany added a commit that referenced this pull request Sep 17, 2025
(cherry picked from commit 0488950)

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
Co-authored-by: Miguel Company <miguelcompany@eprosima.com>
MiguelCompany added a commit that referenced this pull request Sep 17, 2025
Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
(cherry picked from commit 0488950)
MiguelCompany added a commit that referenced this pull request Sep 18, 2025
(cherry picked from commit 0488950)

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
Co-authored-by: Miguel Company <miguelcompany@eprosima.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci-pending PR which CI is running no-test Skip CI tests if PR marked with this label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants