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

[21077] Update Fast DDS docs QoS examples #781

Merged
merged 8 commits into from
Jun 20, 2024
Merged

[21077] Update Fast DDS docs QoS examples #781

merged 8 commits into from
Jun 20, 2024

Conversation

cferreiragonz
Copy link
Contributor

@cferreiragonz cferreiragonz commented May 24, 2024

Description

This PR updates the code examples of the QoS Policy to be more illustrative and include how the modified QoS should be used after editing it.
Additionally, it reviews that the API of QoS is identical for all entities that share a common QoS. It also makes the PropertyPolicyQoS of DataWriters and DataReader unmutable (such as the one of Participants), until a deeper study is made on what Policies should be mutable on enabled entities.

It also includes minor improvements in the readability of the docs (references, tabs, etc).

@Mergifyio backport 2.14.x 2.13.x 2.10.x 2.6.x

Contributor Checklist

  • Commit messages follow the project guidelines.
  • Code snippets related to the added documentation have been provided.
  • Documentation tests pass locally.
  • 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.
  • CI passes without warnings or errors.

@cferreiragonz
Copy link
Contributor Author

@richiprosima please test_3 this

docs/fastdds/dds_layer/core/policy/xtypesExtensions.rst Outdated Show resolved Hide resolved
docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst Outdated Show resolved Hide resolved
docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst Outdated Show resolved Hide resolved
docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst Outdated Show resolved Hide resolved
docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst Outdated Show resolved Hide resolved
code/DDSCodeTester.cpp Outdated Show resolved Hide resolved
code/DDSCodeTester.cpp Outdated Show resolved Hide resolved
code/DDSCodeTester.cpp Show resolved Hide resolved
code/DDSCodeTester.cpp Show resolved Hide resolved
code/DDSCodeTester.cpp Show resolved Hide resolved
@cferreiragonz cferreiragonz changed the title [21077] Review Fast DDS docs QoS examples [21077] Update Fast DDS docs QoS examples Jun 19, 2024
Copy link
Contributor

@Tempate Tempate left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with green CI

@cferreiragonz
Copy link
Contributor Author

@richiprosima please test_3 this

@EduPonz EduPonz merged commit fd95234 into master Jun 20, 2024
4 checks passed
@EduPonz EduPonz deleted the qos_api_review branch June 20, 2024 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants