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

Improved documentation #225

Merged
merged 6 commits into from
Apr 21, 2020
Merged

Improved documentation #225

merged 6 commits into from
Apr 21, 2020

Conversation

ahcorde
Copy link
Contributor

@ahcorde ahcorde commented Apr 8, 2020

  • Included docblock in cmdline_parser.h
  • Homogeneus return details in docblock
  • Included shared library util to readme
  • Fixed docblock in test
  • Added in or inout to param in docbloc

Signed-off-by: ahcorde ahcorde@gmail.com

Signed-off-by: ahcorde <ahcorde@gmail.com>
@ahcorde ahcorde self-assigned this Apr 8, 2020
@ahcorde ahcorde marked this pull request as ready for review April 8, 2020 14:36
Signed-off-by: ahcorde <ahcorde@gmail.com>
Signed-off-by: ahcorde <ahcorde@gmail.com>
Signed-off-by: ahcorde <ahcorde@gmail.com>
Signed-off-by: ahcorde <ahcorde@gmail.com>
@ahcorde ahcorde requested a review from Blast545 April 15, 2020 08:14
Copy link
Contributor

@Blast545 Blast545 left a comment

Choose a reason for hiding this comment

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

Minor comments, otherwise LGTM!

include/rcutils/allocator.h Outdated Show resolved Hide resolved
include/rcutils/allocator.h Outdated Show resolved Hide resolved
include/rcutils/cmdline_parser.h Outdated Show resolved Hide resolved
include/rcutils/logging.h Outdated Show resolved Hide resolved
include/rcutils/logging.h Outdated Show resolved Hide resolved
Signed-off-by: ahcorde <ahcorde@gmail.com>
@ahcorde
Copy link
Contributor Author

ahcorde commented Apr 21, 2020

  • Linux Build Status
  • Linux-aarch64 Build Status
  • macOS Build Status
  • Windows Build Status

@ahcorde ahcorde merged commit 845b7ee into master Apr 21, 2020
@delete-merged-branch delete-merged-branch bot deleted the ahcorde/doc/improve_doc branch April 21, 2020 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants