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

Changes in doxygen to fix warnings on documentation [20850] #4700

Merged
merged 1 commit into from
May 9, 2024
Merged

Changes in doxygen to fix warnings on documentation [20850] #4700

merged 1 commit into from
May 9, 2024

Conversation

richiware
Copy link
Member

@richiware richiware commented Apr 18, 2024 •
edited by EduPonz
Loading

Description

Changes in doxygen to fix warnings on documentation

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

@richiware richiware mentioned this pull request Apr 18, 2024
Merged
6 tasks
@richiware richiware changed the title Changes in doxygen to fix warnings on documentation Changes in doxygen to fix warnings on documentation [20850] Apr 18, 2024
@EduPonz EduPonz force-pushed the 3.0.x-devel branch 3 times, most recently from 5148f5d to bd83bb2 Compare April 23, 2024 05:52
@EduPonz EduPonz added this to the v3.0.0 milestone Apr 24, 2024
@elianalf elianalf added needs-review PR that is ready to be reviewed needs rebase labels Apr 29, 2024
@richiware @EduPonz
Refs #20631. Fix warning on documentation
fd13569 
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
@EduPonz EduPonz force-pushed the bugfix/remove-warning-in-docs branch from 428a272 to fd13569 Compare May 9, 2024 05:27
@EduPonz EduPonz added skip-ci Automatically pass CI and removed needs-review PR that is ready to be reviewed needs rebase labels May 9, 2024
@EduPonz EduPonz merged commit 08ee62b into 3.0.x-devel May 9, 2024
3 checks passed
@EduPonz EduPonz deleted the bugfix/remove-warning-in-docs branch May 9, 2024 06:19
EduPonz pushed a commit that referenced this pull request May 13, 2024
@richiware @EduPonz
Changes in doxygen to fix warnings on documentation (#4700)
623db82 
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
@EduPonz EduPonz mentioned this pull request Jul 2, 2024
Merged
12 tasks
EduPonz added a commit that referenced this pull request Jul 3, 2024
@EduPonz
Remove doxygen warnings (#4700, #5011) (#5016)
28a2e15 
* 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>
mergify bot pushed a commit that referenced this pull request Jul 3, 2024
@EduPonz @mergify
Remove doxygen warnings (#4700, #5011) (#5016)
2e796db 
* 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
@mergify mergify bot mentioned this pull request Jul 3, 2024
Merged
12 tasks
mergify bot pushed a commit that referenced this pull request Jul 3, 2024
@EduPonz @mergify
Remove doxygen warnings (#4700, #5011) (#5016)
632f543 
* 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
@mergify mergify bot mentioned this pull request Jul 3, 2024
Merged
12 tasks
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
@EduPonz @JesusPoderoso
Remove doxygen warnings (#4700, #5011) (#5016)
82be21b 
* 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
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
@EduPonz @JesusPoderoso
Remove doxygen warnings (#4700, #5011) (#5016)
d488cfd 
* 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>
EduPonz added a commit that referenced this pull request Jul 3, 2024
@mergify @EduPonz
Remove doxygen warnings (#4700, #5011) (#5016) (#5024)
a886cff 
* 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>
EduPonz added a commit that referenced this pull request Jul 3, 2024
@EduPonz
Remove doxygen warnings (#4700, #5011) (#5016)
572851a 
* 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>
EduPonz added a commit that referenced this pull request Jul 3, 2024
@mergify @EduPonz
Remove doxygen warnings (#4700, #5011) (#5016) (#5025)
0e4e234 
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@EduPonz EduPonz EduPonz approved these changes

Assignees
No one assigned
Labels
skip-ci Automatically pass CI
Projects
None yet
Milestone
v3.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@richiware @EduPonz @elianalf