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.

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

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

Merged
merged 8 commits into from
Jul 3, 2024

Conversation

EduPonz
Copy link

@EduPonz EduPonz commented Jul 3, 2024

Description

This PR adjusts some Doxydoc so that the pydoc generated for Fast DDS Python does not make RTD build failed. This PR is a follow up of:

This PR is related to:

@Mergifyio backport 2.13.x 2.10.x

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
  • 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.
  • N/A: 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.
  • N/A: Check CI results: changes do not issue any warning.
  • N/A: Check CI results: failing tests are unrelated with the changes.

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

Refs #21114: Split return into several @return

Signed-off-by: eduponz <eduardoponz@eprosima.com>
Signed-off-by: eduponz <eduardoponz@eprosima.com>
Signed-off-by: eduponz <eduardoponz@eprosima.com>
Signed-off-by: eduponz <eduardoponz@eprosima.com>
Signed-off-by: eduponz <eduardoponz@eprosima.com>
Signed-off-by: eduponz <eduardoponz@eprosima.com>
Signed-off-by: eduponz <eduardoponz@eprosima.com>
Signed-off-by: eduponz <eduardoponz@eprosima.com>
@EduPonz EduPonz added this to the v2.14.3 milestone Jul 3, 2024
@EduPonz EduPonz merged commit a78316b into 2.14.x Jul 3, 2024
3 checks passed
@EduPonz EduPonz deleted the hotfix/2.14.x/doxygen branch July 3, 2024 09:08
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
* 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>
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
* 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>
EduPonz added a commit that referenced this pull request Jul 3, 2024
* 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
* 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>
EduPonz added a commit that referenced this pull request Jul 3, 2024
* 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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants