Document how to annotate member as key in XMl types (#746)

Signed-off-by: eduponz <[email protected]> (cherry picked from commit f95e5c9) # Conflicts: # code/XMLTester.xml
eProsima · Apr 30, 2024 · e14be1a · e14be1a
1 parent 11d36d8
commit e14be1a
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/code/XMLTester.xml b/code/XMLTester.xml
@@ -4389,6 +4389,7 @@
 </data_reader>
 <!--><-->
 
+<<<<<<< HEAD
 <!-->XML_RELIABILITY<-->
 <data_writer profile_name="writer_xml_conf_reliability_profile">
     <qos>
@@ -4401,6 +4402,48 @@
         </reliability>
     </qos>
 </data_writer>
+=======
+<!-->XML-GENERIC<-->
+<struct name="primitive_types_example">
+    <!-- Primitive type definitions inside a struct -->
+    <member name="my_bool" type="boolean"/>
+    <member name="my_char" type="char8"/>
+    <member name="my_wchar" type="char16"/>
+    <member name="my_byte" type="byte"/>
+    <member name="my_octet" type="octet"/>
+    <member name="my_uint8" type="uint8"/>
+    <member name="my_short" type="int16"/>
+    <member name="my_long" type="int32"/>
+    <member name="my_unsignedshort" type="uint16"/>
+    <member name="my_unsignedlong" type="uint32"/>
+    <member name="my_longlong" type="int64"/>
+    <member name="my_unsignedlonglong" type="uint64"/>
+    <member name="my_float" type="float32"/>
+    <member name="my_double" type="float64"/>
+    <member name="my_longdouble" type="float128"/>
+    <member name="my_string" type="string"/>
+    <member name="my_wstring" type="wstring"/>
+</struct>
+<!--><-->
+<struct name="MembersExample">
+<!-->XML-MEMBER_WITH_KEY<-->
+<member name="my_long" type="int32" key="true"/>
+<!--><-->
+<!-->XML-BOUNDEDSTRINGS<-->
+<member name="my_large_string" type="string" stringMaxLength="41925"/>
+<member name="my_large_wstring" type="wstring" stringMaxLength="20925"/>
+<!--><-->
+<!-->XML-SEQUENCES<-->
+<member name="short_sequence" sequenceMaxLength="5" type="int16"/>
+<!--><-->
+<!-->XML-ARRAYS<-->
+<member name="long_array" type="int32" arrayDimensions="2,3,4"/>
+<!--><-->
+<!-->XML-MAPS<-->
+<member name="long_long_map" type="int32" key_type="int32" mapMaxLength="2"/>
+<!--><-->
+</struct>
+>>>>>>> f95e5c9 (Document how to annotate member as key in XMl types (#746))
 
 <data_reader profile_name="reader_xml_conf_reliability_profile">
     <qos>

diff --git a/docs/fastdds/xml_configuration/dynamic_types.rst b/docs/fastdds/xml_configuration/dynamic_types.rst
@@ -161,6 +161,12 @@ Member types
 Member types are defined as any type that can belong to a ``<struct>`` or a ``<union>``, or be aliased by a
 ``<typedef>``.
 These can be defined by the ``<member>`` XML tag.
+A member can be annotated as ``key`` (equivalent of the IDL's ``@key``) by setting the ``key`` attribute to ``"true"``.
+
+.. literalinclude:: /../code/XMLTester.xml
+  :language: xml
+  :start-after: <!-->XML-MEMBER_WITH_KEY<-->
+  :end-before: <!--><-->
 
 Primitive types
 ***************