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

Feature documentation of rosidl_runtime_c/cpp and rosidl_typesupport_interface #482

Merged
merged 4 commits into from
May 11, 2020

Conversation

brawner
Copy link
Contributor

@brawner brawner commented May 7, 2020

As part of the effort to push toward higher quality levels, this adds feature documentation for rosidl_runtime_c/cpp and rosidl_typesupport_interface.

Signed-off-by: Stephen Brawner brawner@gmail.com

…interface

Signed-off-by: Stephen Brawner <brawner@gmail.com>
@brawner brawner requested a review from maryaB-osr May 7, 2020 19:34
Copy link

@maryaB-osr maryaB-osr left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

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

Same idea here as rosidl_typesupport or rosidl_typesupport_fastrtps

  • We add QD to doxygen related pages
  • Fix title in FEATURES.ms
  • Links in FEATURES.md are not working. Full URL could be a solution

rosidl_runtime_c/docs/FEATURES.md Outdated Show resolved Hide resolved
rosidl_runtime_c/docs/FEATURES.md Outdated Show resolved Hide resolved
rosidl_runtime_cpp/docs/FEATURES.md Outdated Show resolved Hide resolved
rosidl_runtime_cpp/docs/FEATURES.md Outdated Show resolved Hide resolved
rosidl_typesupport_interface/README.md Show resolved Hide resolved
Signed-off-by: Stephen Brawner <brawner@gmail.com>
Copy link
Contributor Author

@brawner brawner left a comment

Choose a reason for hiding this comment

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

Reconfigured features.md so that the links work in doxygen.

rosidl_typesupport_interface/README.md Show resolved Hide resolved
rosidl_runtime_c/docs/FEATURES.md Outdated Show resolved Hide resolved
rosidl_runtime_c/docs/FEATURES.md Outdated Show resolved Hide resolved
rosidl_runtime_cpp/docs/FEATURES.md Outdated Show resolved Hide resolved
rosidl_runtime_cpp/docs/FEATURES.md Outdated Show resolved Hide resolved
rosidl_typesupport_interface/README.md Show resolved Hide resolved
Copy link
Contributor

@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

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

Please in the QDs change the titles from:

# `rosidl_runtime_c` Quality Declaration

to

# rosidl_runtime_c Quality Declaration

Signed-off-by: Stephen Brawner <brawner@gmail.com>
@brawner
Copy link
Contributor Author

brawner commented May 11, 2020

Ok, fixed the QDs and also added in the feature documentation bit.

Signed-off-by: Stephen Brawner <brawner@gmail.com>
@brawner brawner merged commit afff057 into master May 11, 2020
@delete-merged-branch delete-merged-branch bot deleted the brawner/feature-documentation branch May 11, 2020 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants