add documentation for generators and API (take II) #646

j-rivero · 2022-01-18T19:33:41Z

This is a follow up of #640. Original description:

This PR adds documentation to the type support APIs and generators for C and C++.
A The documentation needs review by someone with a good understanding of rosidl, to ensure it is correct and identify any missing documentation.

Signed-off-by: Geoffrey Biggs <[email protected]>

Signed-off-by: Jose Luis Rivero <[email protected]>

rosidl_typesupport_introspection_c/bin/rosidl_typesupport_introspection_c

rosidl_typesupport_introspection_c/include/rosidl_typesupport_introspection_c/field_types.h

...pesupport_introspection_c/include/rosidl_typesupport_introspection_c/message_introspection.h

rosidl_typesupport_introspection_c/rosidl_typesupport_introspection_c/cli.py

...l_typesupport_introspection_cpp/include/rosidl_typesupport_introspection_cpp/field_types.hpp

...ort_introspection_cpp/include/rosidl_typesupport_introspection_cpp/message_introspection.hpp

...introspection_cpp/include/rosidl_typesupport_introspection_cpp/message_type_support_decl.hpp

…entation

rosidl_typesupport_introspection_c/include/rosidl_typesupport_introspection_c/field_types.h

...pesupport_introspection_c/include/rosidl_typesupport_introspection_c/message_introspection.h

...ort_introspection_cpp/include/rosidl_typesupport_introspection_cpp/message_introspection.hpp

Signed-off-by: Jose Luis Rivero <[email protected]>

sloretz

Almost there!

...pesupport_introspection_c/include/rosidl_typesupport_introspection_c/message_introspection.h

...ort_introspection_cpp/include/rosidl_typesupport_introspection_cpp/message_introspection.hpp

...ort_introspection_cpp/include/rosidl_typesupport_introspection_cpp/service_introspection.hpp

Signed-off-by: Jose Luis Rivero <[email protected]>

sloretz

I think these are the last comments I have

...ort_introspection_cpp/include/rosidl_typesupport_introspection_cpp/message_introspection.hpp

Signed-off-by: Jose Luis Rivero <[email protected]>

j-rivero · 2022-02-01T15:03:55Z

I think these are the last comments I have

Thanks! Sorry I should have searched for other places where we mentioned that "nested types" before. I did it, nothing found now.

sloretz

LGTM with green CI!

j-rivero · 2022-02-01T18:48:57Z

Here we go, packages up to rclcpp:

Linux
Linux-aarch64
Windows

gbiggs and others added 11 commits December 17, 2021 09:57

Add documentation for generators and API

ebc68ed

Signed-off-by: Geoffrey Biggs <[email protected]>

Use single line for comment

c41fbcd

Signed-off-by: Jose Luis Rivero <[email protected]>

Make linter happy, use single line

ba63b71

Signed-off-by: Jose Luis Rivero <[email protected]>

Annotate types in python to match documentation

1b972df

Signed-off-by: Jose Luis Rivero <[email protected]>

Correct explanation on WCHAR

9ea490c

Signed-off-by: Jose Luis Rivero <[email protected]>

Name field_types enum and refers in type_id_

739b377

Signed-off-by: Jose Luis Rivero <[email protected]>

Remove reference to unary type

bd1c007

Signed-off-by: Jose Luis Rivero <[email protected]>

Use cpp namespace instead of plain C

c22fabc

Signed-off-by: Jose Luis Rivero <[email protected]>

Clarify that implementation is downstream libraries

1b1d634

Signed-off-by: Jose Luis Rivero <[email protected]>

Clarify that cli.py is only for accessing to the generators

5eb8f06

Signed-off-by: Jose Luis Rivero <[email protected]>

Note about first argument of functions in message_introscpection

2d013dc

Signed-off-by: Jose Luis Rivero <[email protected]>

j-rivero mentioned this pull request Jan 18, 2022

Add documentation for generators and API #640

Closed

j-rivero added 2 commits January 20, 2022 21:06

Fix pep257 problems

02b8627

Signed-off-by: Jose Luis Rivero <[email protected]>

Missing period in first comment line

9d3c29d

Signed-off-by: Jose Luis Rivero <[email protected]>

j-rivero force-pushed the gbiggs/add-documentation branch from d125298 to 9d3c29d Compare January 20, 2022 20:07

j-rivero mentioned this pull request Jan 24, 2022

Rework nested types' items introspection in C and C++ #652

Merged

sloretz self-requested a review January 25, 2022 18:05

sloretz requested changes Jan 26, 2022

View reviewed changes

j-rivero added 7 commits January 27, 2022 17:49

Use sphinx format and imperative

e509eab

Replace message from POD to just possible types of fields

42fa977

Reference design doc for C enum types and correct char length

19cbeb5

Merge branch 'master' of github.com:ros2/rosidl into gbiggs/add-docum…

5a3f133

…entation

Use imperative for cli.py documentation

8471f31

Remove reference to POD in c++

0963371

Do not assume name of downstream libraries

7616d60

j-rivero requested a review from sloretz January 27, 2022 18:11

sloretz requested changes Jan 27, 2022

View reviewed changes

j-rivero added 3 commits January 27, 2022 21:09

Replace field descriptions by the equivalent C types

d82ae60

Remove the wrong limitation to "Nested interface types"

5ce1497

sphinx documentation for __init__.py

1012ae4

Signed-off-by: Jose Luis Rivero <[email protected]>

j-rivero added 6 commits January 27, 2022 21:16

Sphinx documentation for rosidl_typesupport_introspection_cpp

04b16bd

Replace field comments by the real C++ types equivalencies

e81c752

Signed-off-by: Jose Luis Rivero <[email protected]>

Missing end points

6886431

Sphinx doc for __init__.py

097fd0e

Signed-off-by: Jose Luis Rivero <[email protected]>

Fix the name of namespaces generated

ba5dd8d

Remove refernce to nested interfaces only

7f1d585

j-rivero requested a review from sloretz January 27, 2022 20:37

sloretz reviewed Jan 28, 2022

View reviewed changes

j-rivero added 3 commits January 28, 2022 16:31

Remove nested interfaces only messages

c740f29

Signed-off-by: Jose Luis Rivero <[email protected]>

Remove C reference in cpp file

ec4b833

Add right namespace in cpp file

f6ff3f6

Signed-off-by: Jose Luis Rivero <[email protected]>

j-rivero requested a review from sloretz January 28, 2022 15:35

sloretz requested changes Jan 31, 2022

View reviewed changes

Remove limitation for nested interfaces types

284d4f2

Signed-off-by: Jose Luis Rivero <[email protected]>

j-rivero requested a review from sloretz February 1, 2022 15:04

sloretz approved these changes Feb 1, 2022

View reviewed changes

j-rivero merged commit ea69c52 into master Feb 1, 2022

delete-merged-branch bot deleted the gbiggs/add-documentation branch February 1, 2022 22:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add documentation for generators and API (take II) #646

add documentation for generators and API (take II) #646

j-rivero commented Jan 18, 2022

sloretz left a comment

sloretz left a comment

j-rivero commented Feb 1, 2022

sloretz left a comment

j-rivero commented Feb 1, 2022

add documentation for generators and API (take II) #646

add documentation for generators and API (take II) #646

Conversation

j-rivero commented Jan 18, 2022

sloretz left a comment

Choose a reason for hiding this comment

sloretz left a comment

Choose a reason for hiding this comment

j-rivero commented Feb 1, 2022

sloretz left a comment

Choose a reason for hiding this comment

j-rivero commented Feb 1, 2022