Skip to content

Commit c27e5e6

Browse files
Document how to annotate member as key in XMl types (#746) (#755)
Signed-off-by: eduponz <eduardoponz@eprosima.com> (cherry picked from commit f95e5c9) Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>
1 parent 88bd70a commit c27e5e6

2 files changed

Lines changed: 9 additions & 0 deletions

File tree

code/XMLTester.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4250,6 +4250,9 @@
42504250
</struct>
42514251
<!--><-->
42524252
<struct name="MembersExample">
4253+
<!-->XML-MEMBER_WITH_KEY<-->
4254+
<member name="my_long" type="int32" key="true"/>
4255+
<!--><-->
42534256
<!-->XML-BOUNDEDSTRINGS<-->
42544257
<member name="my_large_string" type="string" stringMaxLength="41925"/>
42554258
<member name="my_large_wstring" type="wstring" stringMaxLength="20925"/>

docs/fastdds/xml_configuration/dynamic_types.rst

Lines changed: 6 additions & 0 deletions
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)