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

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

Merged
merged 33 commits into from
Feb 1, 2022
Merged
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
ebc68ed
Add documentation for generators and API
gbiggs Dec 17, 2021
c41fbcd
Use single line for comment
j-rivero Jan 15, 2022
ba63b71
Make linter happy, use single line
j-rivero Jan 15, 2022
1b972df
Annotate types in python to match documentation
j-rivero Jan 15, 2022
9ea490c
Correct explanation on WCHAR
j-rivero Jan 15, 2022
739b377
Name field_types enum and refers in type_id_
j-rivero Jan 15, 2022
bd1c007
Remove reference to unary type
j-rivero Jan 16, 2022
c22fabc
Use cpp namespace instead of plain C
j-rivero Jan 16, 2022
1b1d634
Clarify that implementation is downstream libraries
j-rivero Jan 16, 2022
5eb8f06
Clarify that cli.py is only for accessing to the generators
j-rivero Jan 16, 2022
2d013dc
Note about first argument of functions in message_introscpection
j-rivero Jan 16, 2022
02b8627
Fix pep257 problems
j-rivero Jan 20, 2022
9d3c29d
Missing period in first comment line
j-rivero Jan 20, 2022
e509eab
Use sphinx format and imperative
j-rivero Jan 27, 2022
42fa977
Replace message from POD to just possible types of fields
j-rivero Jan 27, 2022
19cbeb5
Reference design doc for C enum types and correct char length
j-rivero Jan 27, 2022
5a3f133
Merge branch 'master' of github.com:ros2/rosidl into gbiggs/add-docum…
j-rivero Jan 27, 2022
8471f31
Use imperative for cli.py documentation
j-rivero Jan 27, 2022
0963371
Remove reference to POD in c++
j-rivero Jan 27, 2022
7616d60
Do not assume name of downstream libraries
j-rivero Jan 27, 2022
d82ae60
Replace field descriptions by the equivalent C types
j-rivero Jan 27, 2022
5ce1497
Remove the wrong limitation to "Nested interface types"
j-rivero Jan 27, 2022
1012ae4
sphinx documentation for __init__.py
j-rivero Jan 27, 2022
04b16bd
Sphinx documentation for rosidl_typesupport_introspection_cpp
j-rivero Jan 27, 2022
e81c752
Replace field comments by the real C++ types equivalencies
j-rivero Jan 27, 2022
6886431
Missing end points
j-rivero Jan 27, 2022
097fd0e
Sphinx doc for __init__.py
j-rivero Jan 27, 2022
ba5dd8d
Fix the name of namespaces generated
j-rivero Jan 27, 2022
7f1d585
Remove refernce to nested interfaces only
j-rivero Jan 27, 2022
c740f29
Remove nested interfaces only messages
j-rivero Jan 28, 2022
ec4b833
Remove C reference in cpp file
j-rivero Jan 28, 2022
f6ff3f6
Add right namespace in cpp file
j-rivero Jan 28, 2022
284d4f2
Remove limitation for nested interfaces types
j-rivero Feb 1, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Replace field comments by the real C++ types equivalencies
Signed-off-by: Jose Luis Rivero <jrivero@osrfoundation.org>
j-rivero committed Jan 27, 2022
commit e81c752aa11693b4854145cf17678f94ddef1d1f
Original file line number Diff line number Diff line change
@@ -24,39 +24,39 @@ namespace rosidl_typesupport_introspection_cpp
/// The equivalent OMG IDL and C++ types of the different fields can be found
/// at http://design.ros2.org/articles/idl_interface_definition.html#type-mapping

/// IEEE-754 binary32 format floating point number.
/// Equivalent to float in C++ types.
const uint8_t ROS_TYPE_FLOAT = rosidl_typesupport_introspection_c__ROS_TYPE_FLOAT;
/// IEEE-754 binary64 format floating point number.
/// Equivalent to double in C++ types.
const uint8_t ROS_TYPE_DOUBLE = rosidl_typesupport_introspection_c__ROS_TYPE_DOUBLE;
/// IEEE-754 binary128 format floating point number.
/// Equivalent to long double in C++ types.
const uint8_t ROS_TYPE_LONG_DOUBLE = rosidl_typesupport_introspection_c__ROS_TYPE_LONG_DOUBLE;
/// Unsigned char, 8 bits wide.
/// Equivalent to unsigned char in C++ types.
const uint8_t ROS_TYPE_CHAR = rosidl_typesupport_introspection_c__ROS_TYPE_CHAR;
/// Wide character, large enough to support Unicode code points.
/// Equivalent to char16_t in C++ types.
const uint8_t ROS_TYPE_WCHAR = rosidl_typesupport_introspection_c__ROS_TYPE_WCHAR;
/// Boolean value. The size is implementation defined.
/// Equivalent to bool in C++ types.
const uint8_t ROS_TYPE_BOOLEAN = rosidl_typesupport_introspection_c__ROS_TYPE_BOOLEAN;
/// A single unsigned byte in raw form.
/// Equivalent to std::byte in C++ types.
const uint8_t ROS_TYPE_OCTET = rosidl_typesupport_introspection_c__ROS_TYPE_OCTET;
/// Unsigned 8-bit integer.
/// Equivalent to uint8_t in C++ types.
const uint8_t ROS_TYPE_UINT8 = rosidl_typesupport_introspection_c__ROS_TYPE_UINT8;
/// Signed 8-bit integer.
/// Equivalent to int8_t in C++ types.
const uint8_t ROS_TYPE_INT8 = rosidl_typesupport_introspection_c__ROS_TYPE_INT8;
/// Unsigned 16-bit integer.
/// Equivalent to uint16_t in C++ types.
const uint8_t ROS_TYPE_UINT16 = rosidl_typesupport_introspection_c__ROS_TYPE_UINT16;
/// Signed 16-bit integer.
/// Equivalent to int16_t in C++ types.
const uint8_t ROS_TYPE_INT16 = rosidl_typesupport_introspection_c__ROS_TYPE_INT16;
/// Unsigned 32-bit integer.
/// Equivalent to uint32_t in C++ types.
const uint8_t ROS_TYPE_UINT32 = rosidl_typesupport_introspection_c__ROS_TYPE_UINT32;
/// Signed 32-bit integer.
/// Equivalent to int32_t in C++ types.
const uint8_t ROS_TYPE_INT32 = rosidl_typesupport_introspection_c__ROS_TYPE_INT32;
/// Unsigned 64-bit integer.
/// Equivalent to uint64_t in C++ types.
const uint8_t ROS_TYPE_UINT64 = rosidl_typesupport_introspection_c__ROS_TYPE_UINT64;
/// Signed 64-bit integer.
/// Equivalent to int64_t in C++ types.
const uint8_t ROS_TYPE_INT64 = rosidl_typesupport_introspection_c__ROS_TYPE_INT64;
/// String, represented as an array of char's.
/// Equivalent to std::string in C++ types.
const uint8_t ROS_TYPE_STRING = rosidl_typesupport_introspection_c__ROS_TYPE_STRING;
/// Wide string, represented as an array of elements at least 16-bits wide each.
/// Equivalent to std::u16string in C++ types.
const uint8_t ROS_TYPE_WSTRING = rosidl_typesupport_introspection_c__ROS_TYPE_WSTRING;

/// An embedded message type.