-
Notifications
You must be signed in to change notification settings - Fork 783
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>
MiguelCompany
approved these changes
Jul 3, 2024
This was referenced Jul 3, 2024
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
versions.md
file (if applicable).Reviewer Checklist