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

[14470] Improve doxygen documentation related to Locator classes. #2672

Merged
merged 15 commits into from
May 20, 2022
Merged

[14470] Improve doxygen documentation related to Locator classes. #2672

merged 15 commits into from
May 20, 2022

Conversation

JLBuenoLopez
Copy link
Contributor

@JLBuenoLopez JLBuenoLopez commented May 9, 2022 •
edited by MiguelCompany
Loading

Description

This PR improves doxygen documentation related to Locator classes improving thus the API reference.

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.
  • 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).

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.

@JLBuenoLopez
Refs #14470: macro definitions doxydoc
8e09640 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: IsAddressDefined doxydoc
79a9920 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: IsLocatorValid doxydoc
9e25c2c 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: complete Locator_t class doxydoc
748cbb9 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: LocatorList class doxydoc
284c5f5 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: LocatorsIterator struct doxydoc
67dc261 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: fix LocatorList doxydoc
95c80e7 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: Add doxydoc to iterators typedef
efc39da 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: complete Locators doxydoc
22fdbaa 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: add locator operators doxydoc
8c5643d 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: fix param name
c5f372b 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: add locator list comparison operator doxydoc
92ffea9 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez JLBuenoLopez added the skip-ci Automatically pass CI label May 9, 2022
@JLBuenoLopez JLBuenoLopez mentioned this pull request May 9, 2022
Merged
@JLBuenoLopez
Copy link
Contributor Author

@richiprosima please check style

MiguelCompany
MiguelCompany requested changes May 9, 2022
View reviewed changes
include/fastdds/rtps/common/Locator.h Outdated Show resolved Hide resolved
include/fastdds/rtps/common/Locator.h Outdated Show resolved Hide resolved
include/fastdds/rtps/common/Locator.h Outdated Show resolved Hide resolved
include/fastdds/rtps/common/Locator.h Outdated Show resolved Hide resolved
include/fastdds/rtps/common/LocatorList.hpp Outdated Show resolved Hide resolved
include/fastdds/rtps/common/LocatorList.hpp Outdated Show resolved Hide resolved
@JLBuenoLopez
Refs #14470: apply review suggestions
a129bb6 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: fix spelling
a3b8f78 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez JLBuenoLopez added this to the v2.6.1 milestone May 19, 2022
MiguelCompany
MiguelCompany requested changes May 19, 2022
View reviewed changes
include/fastdds/rtps/common/Locator.h Outdated Show resolved Hide resolved
include/fastdds/rtps/common/Locator.h Outdated Show resolved Hide resolved
include/fastdds/rtps/common/LocatorList.hpp Show resolved Hide resolved
include/fastdds/rtps/common/LocatorList.hpp Show resolved Hide resolved
@JLBuenoLopez
Refs #14470: apply review suggestions
b525d60 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@MiguelCompany MiguelCompany added no-test Skip CI tests if PR marked with this label no-aarch Skip build & test for aarch64 and removed skip-ci Automatically pass CI labels May 20, 2022
@MiguelCompany
Copy link
Member

@richiprosima Please test this

MiguelCompany
MiguelCompany approved these changes May 20, 2022
View reviewed changes
Copy link
Member

@MiguelCompany MiguelCompany left a comment

Choose a reason for hiding this comment

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

LGTM. I've triggered a build-only CI just in case.

@MiguelCompany
Copy link
Member

Documentation job failed due to doxygen comments here:

fastdds/api_reference/rtps/common/Locator/operators.rst:None: (locatorN)  Insertion operator: serialize a locator list. The deserialization format is [locator1,locator2,...,locatorN]. Each individual locator within the list must follow the serialization format explained in the locator insertion operator. 
fastdds/api_reference/rtps/common/Locator/operators.rst:None: (locatorN)  Extraction operator: deserialize a list of locators. The serialization format is [locator1,locator2,...,locatorN]. Each individual locator within the list must follow the deserialization format explained in the locator extraction operator.

@JLBuenoLopez
Copy link
Contributor Author

Thanks @MiguelCompany! Fixed already in eProsima/Fast-DDS-docs#367

@MiguelCompany MiguelCompany removed no-test Skip CI tests if PR marked with this label no-aarch Skip build & test for aarch64 labels May 20, 2022
@MiguelCompany MiguelCompany added the ready-to-merge Ready to be merged. CI and changes have been reviewed and approved. label May 20, 2022
@MiguelCompany MiguelCompany merged commit 6a978a7 into master May 20, 2022
@MiguelCompany MiguelCompany deleted the hotfix/locator-doxydoc branch May 20, 2022 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MiguelCompany MiguelCompany MiguelCompany approved these changes

Assignees
No one assigned
Labels
ready-to-merge Ready to be merged. CI and changes have been reviewed and approved.
Projects
None yet
Milestone
v2.6.1
Development

Successfully merging this pull request may close these issues.
2 participants
@JLBuenoLopez @MiguelCompany