@@ -32,18 +32,61 @@ extern "C"
3232// Memory rule
3333typedef struct micro_ros_utilities_memory_rule_t
3434{
35+ /**
36+ * Pattern matching the fully qualified name of a msg field.
37+ *
38+ */
3539 const char * rule ;
40+
41+ /**
42+ * Maximum string or sequence capacity for fields matching \ref rule.
43+ *
44+ */
3645 size_t size ;
3746} micro_ros_utilities_memory_rule_t ;
3847
3948// Memory configuration string
4049typedef struct micro_ros_utilities_memory_conf_t
4150{
51+ /**
52+ * Maximum string capacity to use for msg fields in case they don't have a
53+ * custom rule assigned to them.
54+ *
55+ */
4256 size_t max_string_capacity ;
57+
58+ /**
59+ * Maximum capacity to use for sequence type msg fields (ie: unbounded
60+ * arrays and lists) which contain ROS 2 msg types, in case they don't have
61+ * a custom rule assigned to them.
62+ *
63+ */
4364 size_t max_ros2_type_sequence_capacity ;
65+
66+ /**
67+ * Maximum capacity to use for sequence type msg fields (ie: unbounded
68+ * arrays and lists) which contain basic types (ie: primitive field types),
69+ * in case they don't have a custom rule assigned to them.
70+ *
71+ */
4472 size_t max_basic_type_sequence_capacity ;
73+
74+ /**
75+ * All rules defined in this configuration.
76+ *
77+ */
4578 const micro_ros_utilities_memory_rule_t * rules ;
79+
80+ /**
81+ * Total number of rules defined in this configuration.
82+ *
83+ */
4684 size_t n_rules ;
85+
86+ /**
87+ * The allocator to use when applying this configuration.
88+ *
89+ */
4790 const rcutils_allocator_t * allocator ;
4891} micro_ros_utilities_memory_conf_t ;
4992
@@ -56,7 +99,7 @@ static const micro_ros_utilities_memory_conf_t micro_ros_utilities_memory_conf_d
5699 */
57100
58101/**
59- * Returns a string with the type instronspection data
102+ * Returns a string with the type introspection data
60103 *
61104 * <hr>
62105 * Attribute | Adherence
0 commit comments