Skip to content

[16315] Doxygen documentation: add deprecation notice to ThroughputControllerDescriptor#3165

Merged
EduPonz merged 2 commits intomasterfrom
hotfix/doxydoc-deprecate-throughput-controller
Jan 18, 2023
Merged

[16315] Doxygen documentation: add deprecation notice to ThroughputControllerDescriptor#3165
EduPonz merged 2 commits intomasterfrom
hotfix/doxydoc-deprecate-throughput-controller

Conversation

@JLBuenoLopez
Copy link
Copy Markdown
Contributor

@JLBuenoLopez JLBuenoLopez commented Dec 20, 2022

Signed-off-by: JLBuenoLopez-eProsima joseluisbueno@eprosima.com

Description

Since Fast DDS v2.4.0, flow controllers have substituted the previous throughput controllers.
This PR fixes the Doxygen documentation so the methods and structures superseded are shown as deprecated.

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.
    N/A Any new/modified methods have been properly documented using Doxygen.
    N/A Fast DDS test suite has been run locally.
  • Changes are ABI compatible.
  • Changes are API compatible.
  • Documentation builds and tests pass locally.
    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.

Reviewer Checklist

  • Check contributor checklist is correct.
  • Check CI results: changes do not issue any warning.
  • Check CI results: failing tests are unrelated with the changes.

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez JLBuenoLopez added the skip-ci Automatically pass CI label Dec 20, 2022
@JLBuenoLopez
Copy link
Copy Markdown
Contributor Author

@Mergifyio backport 2.8.x 2.7.x 2.6.x

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Dec 20, 2022

@JLBuenoLopez JLBuenoLopez added this to the v2.9.1 milestone Dec 20, 2022
EduPonz
EduPonz previously approved these changes Jan 16, 2023
@EduPonz
Copy link
Copy Markdown

EduPonz commented Jan 16, 2023

@JLBuenoLopez-eProsima please address uncrustify failure

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Copy link
Copy Markdown
Contributor Author

Linters fixed!

@EduPonz EduPonz merged commit d34a076 into master Jan 18, 2023
@EduPonz EduPonz deleted the hotfix/doxydoc-deprecate-throughput-controller branch January 18, 2023 08:36
mergify bot pushed a commit that referenced this pull request Jan 18, 2023
…Descriptor (#3165)

* Refs #16315: deprecation notice ThroughputControllerDescriptor

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

* Refs #16315: fix linters

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
(cherry picked from commit d34a076)
mergify bot pushed a commit that referenced this pull request Jan 18, 2023
…Descriptor (#3165)

* Refs #16315: deprecation notice ThroughputControllerDescriptor

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

* Refs #16315: fix linters

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
(cherry picked from commit d34a076)
mergify bot pushed a commit that referenced this pull request Jan 18, 2023
…Descriptor (#3165)

* Refs #16315: deprecation notice ThroughputControllerDescriptor

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

* Refs #16315: fix linters

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
(cherry picked from commit d34a076)

# Conflicts:
#	include/fastdds/dds/core/policy/QosPolicies.hpp
#	include/fastdds/rtps/attributes/RTPSParticipantAttributes.h
MiguelCompany pushed a commit that referenced this pull request Jan 26, 2023
…Descriptor (#3227)

* Doxygen documentation: add deprecation notice to ThroughputControllerDescriptor (#3165)

* Refs #16315: deprecation notice ThroughputControllerDescriptor

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

* Refs #16315: fix linters

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
(cherry picked from commit d34a076)

# Conflicts:
#	include/fastdds/dds/core/policy/QosPolicies.hpp
#	include/fastdds/rtps/attributes/RTPSParticipantAttributes.h

* Refs #15315: fix conflicts

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
Co-authored-by: José Luis Bueno López <69244257+JLBuenoLopez-eProsima@users.noreply.github.com>
Co-authored-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-ci Automatically pass CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants