From 64d6e9891d93511d7fa34ea0c8f588f187379482 Mon Sep 17 00:00:00 2001 From: Dirk Thomas Date: Thu, 25 Aug 2016 08:24:03 -0700 Subject: [PATCH] add doc for array fields size and capacity --- .../include/rosidl_generator_c/primitives_array.h | 4 ++-- rosidl_generator_c/resource/msg__struct.h.em | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/rosidl_generator_c/include/rosidl_generator_c/primitives_array.h b/rosidl_generator_c/include/rosidl_generator_c/primitives_array.h index ced6ab070..6f3386286 100644 --- a/rosidl_generator_c/include/rosidl_generator_c/primitives_array.h +++ b/rosidl_generator_c/include/rosidl_generator_c/primitives_array.h @@ -23,8 +23,8 @@ typedef struct rosidl_generator_c__ ## STRUCT_NAME ## __Array \ { \ TYPE_NAME * data; \ - size_t size; \ - size_t capacity; \ + size_t size; /*!< The number of valid items in data */ \ + size_t capacity; /*!< The number of allocated items in data */ \ } rosidl_generator_c__ ## STRUCT_NAME ## __Array; // array types for all primitive types diff --git a/rosidl_generator_c/resource/msg__struct.h.em b/rosidl_generator_c/resource/msg__struct.h.em index 84801b935..a88245017 100644 --- a/rosidl_generator_c/resource/msg__struct.h.em +++ b/rosidl_generator_c/resource/msg__struct.h.em @@ -165,7 +165,9 @@ typedef struct @(msg_typename) typedef struct @(array_typename) { @(msg_typename) * data; + /// The number of valid items in data size_t size; + /// The number of allocated items in data size_t capacity; } @(array_typename);