Skip to content

Commit f95e5c9

Browse files
authored
Document how to annotate member as key in XMl types (#746)
Signed-off-by: eduponz <[email protected]>
1 parent 17960bb commit f95e5c9

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

Diff for: code/XMLTester.xml

+3
Original file line numberDiff line numberDiff line change
@@ -4358,6 +4358,9 @@
43584358
</struct>
43594359
<!--><-->
43604360
<struct name="MembersExample">
4361+
<!-->XML-MEMBER_WITH_KEY<-->
4362+
<member name="my_long" type="int32" key="true"/>
4363+
<!--><-->
43614364
<!-->XML-BOUNDEDSTRINGS<-->
43624365
<member name="my_large_string" type="string" stringMaxLength="41925"/>
43634366
<member name="my_large_wstring" type="wstring" stringMaxLength="20925"/>

Diff for: docs/fastdds/xml_configuration/dynamic_types.rst

+6
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,12 @@ Member types
6060
Member types are defined as any type that can belong to a `Struct`_ or a `Union`_, or be aliased by a
6161
`Typedef`_.
6262
These can be defined by the ``<member>`` XML tag.
63+
A member can be annotated as ``key`` (equivalent of the IDL's ``@key``) by setting the ``key`` attribute to ``"true"``.
64+
65+
.. literalinclude:: /../code/XMLTester.xml
66+
:language: xml
67+
:start-after: <!-->XML-MEMBER_WITH_KEY<-->
68+
:end-before: <!--><-->
6369

6470
Primitive types
6571
***************

0 commit comments

Comments
 (0)