[21114] Remove doxygen warnings (#4700, #5011) by EduPonz · Pull Request #5016 · eProsima/Fast-DDS

EduPonz · 2024-07-02T11:10:10Z

Description

This PR is a manual backport to 2.14.x of two PRs:

This work has been done so the following docs PR passes CI:

[21114] Check suprocess return codes on RDT generation (backport #795) Fast-DDS-docs#796

Related PRs:

@Mergifyio backport 2.13.x 2.10.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.
- Related documentation PR: [21114] Check suprocess return codes on RDT generation (backport #795) Fast-DDS-docs#796
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.
N/A: 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: eduponz <eduardoponz@eprosima.com>

include/fastdds/dds/domain/DomainParticipantListener.hpp

include/fastdds/rtps/common/Types.h

Signed-off-by: eduponz <eduardoponz@eprosima.com>

EduPonz · 2024-07-03T08:42:50Z

@Mergifyio backport 2.13.x 2.10.x

mergify · 2024-07-03T08:42:59Z

backport 2.13.x 2.10.x

✅ Backports have been created

Details

#5024 [21114] Remove doxygen warnings (#4700, #5011) (backport #5016) has been created for branch 2.13.x but encountered conflicts
#5025 [21114] Remove doxygen warnings (#4700, #5011) (backport #5016) has been created for branch 2.10.x but encountered conflicts

* Refs #21114: Remove doxygen warnings Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Apply Miguel's suggestions Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> (cherry picked from commit 28a2e15) # Conflicts: # include/fastdds/dds/core/policy/QosPolicies.hpp # include/fastdds/dds/publisher/Publisher.hpp # include/fastdds/dds/subscriber/Subscriber.hpp

* Refs #21114: Remove doxygen warnings Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Apply Miguel's suggestions Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> (cherry picked from commit 28a2e15) # Conflicts: # include/fastdds/dds/core/policy/QosPolicies.hpp # include/fastdds/dds/publisher/Publisher.hpp # include/fastdds/dds/subscriber/Subscriber.hpp Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>

@return

* Remove doxygen warnings (#4700, #5011) (#5016) * Refs #21114: Remove doxygen warnings Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Apply Miguel's suggestions Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> (cherry picked from commit 28a2e15) # Conflicts: # include/fastdds/dds/core/policy/QosPolicies.hpp # include/fastdds/dds/publisher/Publisher.hpp # include/fastdds/dds/subscriber/Subscriber.hpp Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Adjust doxygen so Fast DDS Python pydoc makes RTD build (#5026) * Refs #21114: Fix dispose Signed-off-by: eduponz <eduardoponz@eprosima.com> Refs #21114: Split return into several @return Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix register_instance Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix unregister_instance Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix read_next_instance_w_condition Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix take_w_condition Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix take_instance Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix take_next_instance Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix take_next_instance_w_condition Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>

* Refs #21114: Remove doxygen warnings Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Apply Miguel's suggestions Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> (cherry picked from commit 28a2e15) Signed-off-by: eduponz <eduardoponz@eprosima.com>

@return

* Remove doxygen warnings (#4700, #5011) (#5016) * Refs #21114: Remove doxygen warnings Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Apply Miguel's suggestions Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> (cherry picked from commit 28a2e15) Signed-off-by: eduponz <eduardoponz@eprosima.com> * Adjust doxygen so Fast DDS Python pydoc makes RTD build (#5026) * Refs #21114: Fix dispose Signed-off-by: eduponz <eduardoponz@eprosima.com> Refs #21114: Split return into several @return Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix register_instance Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix unregister_instance Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix read_next_instance_w_condition Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix take_w_condition Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix take_instance Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix take_next_instance Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix take_next_instance_w_condition Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>

Refs #21114: Remove doxygen warnings

f9f36ce

Signed-off-by: eduponz <eduardoponz@eprosima.com>

EduPonz added this to the v2.14.3 milestone Jul 2, 2024

This was referenced Jul 2, 2024

[21114] Remove doxygen warnings (#121) eProsima/Fast-DDS-python#154

Merged

[21114] Check suprocess return codes on RDT generation (backport #795) eProsima/Fast-DDS-docs#796

Merged

EduPonz added no-test Skip CI tests if PR marked with this label labels Jul 2, 2024

EduPonz requested review from MiguelCompany July 2, 2024 14:34

github-actions bot added the ci-pending PR which CI is running label Jul 2, 2024

MiguelCompany requested changes Jul 2, 2024

View reviewed changes

include/fastdds/dds/domain/DomainParticipantListener.hpp Outdated Show resolved Hide resolved

include/fastdds/rtps/common/Types.h Outdated Show resolved Hide resolved

EduPonz added skip-ci Automatically pass CI and removed no-test Skip CI tests if PR marked with this label labels Jul 3, 2024

Refs #21114: Apply Miguel's suggestions

ff2994a

Signed-off-by: eduponz <eduardoponz@eprosima.com>

MiguelCompany approved these changes Jul 3, 2024

View reviewed changes

EduPonz merged commit 28a2e15 into 2.14.x Jul 3, 2024

EduPonz deleted the mergify/bp/2.14.x/pr-795 branch July 3, 2024 05:28

mergify bot mentioned this pull request Jul 3, 2024

[21114] Remove doxygen warnings (#4700, #5011) (backport #5016) #5024

Merged

12 tasks

This was referenced Jul 3, 2024

[21114] Remove doxygen warnings (#4700, #5011) (backport #5016) #5025

Merged

[21114] Remove doxygen warnings (#121) (backport #154) eProsima/Fast-DDS-python#155

Merged

[21114] Remove doxygen warnings (#121) (backport #154) eProsima/Fast-DDS-python#156

Open

EduPonz mentioned this pull request Jul 3, 2024

[21114] Adjust doxygen so Fast DDS Python pydoc makes RTD build #5026

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[21114] Remove doxygen warnings (#4700, #5011)#5016

[21114] Remove doxygen warnings (#4700, #5011)#5016
EduPonz merged 2 commits into2.14.xfrom
mergify/bp/2.14.x/pr-795

EduPonz commented Jul 2, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

EduPonz commented Jul 3, 2024

Uh oh!

mergify bot commented Jul 3, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

EduPonz commented Jul 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Contributor Checklist

Reviewer Checklist

Uh oh!

Uh oh!

Uh oh!

EduPonz commented Jul 3, 2024

Uh oh!

mergify bot commented Jul 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Backports have been created

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

EduPonz commented Jul 2, 2024 •

edited

Loading

mergify bot commented Jul 3, 2024 •

edited

Loading