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 locator API reference #367

Merged
merged 7 commits into from
May 20, 2022
Merged

[14470] Improve locator API reference #367

merged 7 commits into from
May 20, 2022

Conversation

JLBuenoLopez
Copy link
Contributor

This PR improves the locator API reference section:

  1. including a missing class and some missing operators.
  2. It also uses the new fastdds namespace instead of the fastrtps one, when possible.
  3. Finally, it enables the option breathe_show_define_initializer so the define macros are included into the API reference with its values.

This PR is related with eProsima/Fast-DDS#2672

@JLBuenoLopez
Refs #14470: include define initializer option
4792339 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: use fastdds namespace instead of fastrtps
2916623 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: remove duplicated class definition in fastrtps namespace
9e460c4 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: add missing public API class Locators
038e239 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #14470: add deserialization operators for locator and locator list
6b746e8 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez JLBuenoLopez mentioned this pull request May 9, 2022
Merged
10 tasks
@JLBuenoLopez
Refs #14470: fix spelling
586d4d1 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez JLBuenoLopez added this to the 2.6.1 milestone May 19, 2022
@MiguelCompany MiguelCompany self-requested a review May 19, 2022 09:12
MiguelCompany
MiguelCompany previously approved these changes May 19, 2022
View reviewed changes
@MiguelCompany
Copy link
Member

@JLBuenoLopez-eProsima Please look at the spell check failure

@JLBuenoLopez
Refs #14470: fix spelling
4508754 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
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.

👍

@MiguelCompany MiguelCompany merged commit 6a69690 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
Projects
None yet
Milestone
2.6.1
Development

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