Skip to content

[8789] Fix doxygen documentation #2572

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
Merged
merged 4 commits into from
Mar 14, 2022
Merged

[8789] Fix doxygen documentation #2572

merged 4 commits into from
Mar 14, 2022

Conversation

JLBuenoLopez
Copy link
Contributor

@JLBuenoLopez JLBuenoLopez commented Mar 10, 2022 •
edited by MiguelCompany
Loading

Signed-off-by: JLBuenoLopez-eProsima [email protected]

Description

Complete Doxygen documentation of Locator_t class.

Fix spelling in Transport layer Doxygen documentation.

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.
  • N/A Changes are ABI compatible.
  • N/A Changes are API compatible.
  • N/A Documentation builds and tests pass locally.
  • N/A New feature has been added to the versions.md file (if applicable).
  • New feature has been documented/Current behavior is correctly described in the documentation.
    Related documentation PR: [8789] Transport Layer API reference Fast-DDS-docs#356

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 #8789: complete Locator doxydoc
d95d913 
Signed-off-by: JLBuenoLopez-eProsima <[email protected]>
@JLBuenoLopez JLBuenoLopez added the skip-ci Automatically pass CI label Mar 10, 2022
@JLBuenoLopez JLBuenoLopez added this to the v2.6.0 milestone Mar 10, 2022
@JLBuenoLopez JLBuenoLopez marked this pull request as draft March 10, 2022 15:56
@JLBuenoLopez JLBuenoLopez marked this pull request as ready for review March 11, 2022 07:16
@JLBuenoLopez JLBuenoLopez changed the title [8789] Complete Locator_t doxygen documentation [8789] Fix doxygen documentation Mar 11, 2022
@JLBuenoLopez JLBuenoLopez mentioned this pull request Mar 11, 2022
Merged
MiguelCompany
MiguelCompany requested changes Mar 11, 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.

Just a nit

@JLBuenoLopez
Refs #8789: apply review suggestion
b378aa5 
Signed-off-by: JLBuenoLopez-eProsima <[email protected]>
MiguelCompany
MiguelCompany approved these changes Mar 11, 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

@MiguelCompany MiguelCompany added the ready-to-merge Ready to be merged. CI and changes have been reviewed and approved. label Mar 14, 2022
@MiguelCompany MiguelCompany merged commit 165816d into master Mar 14, 2022
@MiguelCompany MiguelCompany deleted the feature/transport-api-reference branch March 14, 2022 06:54
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. skip-ci Automatically pass CI
Projects
None yet
Milestone
v2.6.0
Development

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