Skip to content

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

Merged
EduPonz merged 2 commits into2.13.xfrom
mergify/bp/2.13.x/pr-5016
Jul 3, 2024
Merged

[21114] Remove doxygen warnings (#4700, #5011) (backport #5016)#5024
EduPonz merged 2 commits into2.13.xfrom
mergify/bp/2.13.x/pr-5016

Conversation

@mergify
Copy link
Contributor

@mergify mergify bot commented Jul 3, 2024

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:

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.
  • 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.

This is an automatic backport of pull request #5016 done by [Mergify](https://mergify.com).

@mergify mergify bot added the conflicts Backport PR wich git cherry pick failed label Jul 3, 2024
@mergify
Copy link
Contributor Author

mergify bot commented Jul 3, 2024

Cherry-pick of 28a2e15 has failed:

On branch mergify/bp/2.13.x/pr-5016
Your branch is up to date with 'origin/2.13.x'.

You are currently cherry-picking commit 28a2e15f7.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   include/fastdds/dds/domain/DomainParticipant.hpp
	modified:   include/fastdds/dds/domain/DomainParticipantFactory.hpp
	modified:   include/fastdds/dds/domain/DomainParticipantListener.hpp
	modified:   include/fastdds/dds/publisher/DataWriter.hpp
	modified:   include/fastdds/dds/subscriber/DataReader.hpp
	modified:   include/fastdds/rtps/common/ChangeKind_t.hpp
	modified:   include/fastdds/rtps/common/FragmentNumber.h
	modified:   include/fastdds/rtps/common/MatchingInfo.h
	modified:   include/fastdds/rtps/common/SequenceNumber.h
	modified:   include/fastdds/rtps/common/Types.h

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   include/fastdds/dds/core/policy/QosPolicies.hpp
	both modified:   include/fastdds/dds/publisher/Publisher.hpp
	both modified:   include/fastdds/dds/subscriber/Subscriber.hpp

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@EduPonz
Copy link

EduPonz commented Jul 3, 2024

This PR should also include the changes from:

@EduPonz EduPonz added this to the v2.13.6 milestone Jul 3, 2024
@JesusPoderoso JesusPoderoso force-pushed the mergify/bp/2.13.x/pr-5016 branch from 2e796db to ffea8df Compare July 3, 2024 10:05
EduPonz added 2 commits July 3, 2024 12:05
* 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>
* 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>
@JesusPoderoso JesusPoderoso force-pushed the mergify/bp/2.13.x/pr-5016 branch from ffea8df to 10f88d3 Compare July 3, 2024 10:05
@JesusPoderoso JesusPoderoso added skip-ci Automatically pass CI and removed conflicts Backport PR wich git cherry pick failed labels Jul 3, 2024
@JesusPoderoso JesusPoderoso self-requested a review July 3, 2024 10:26
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 JesusPoderoso added the ready-to-merge Ready to be merged. CI and changes have been reviewed and approved. label Jul 3, 2024
@EduPonz EduPonz merged commit a886cff into 2.13.x Jul 3, 2024
@EduPonz EduPonz deleted the mergify/bp/2.13.x/pr-5016 branch July 3, 2024 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-to-merge Ready to be merged. CI and changes have been reviewed and approved. skip-ci Automatically pass CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants