From b78c9c7a87c1e4897587834573c3d97403a2ba14 Mon Sep 17 00:00:00 2001
From: eduponz <eduardoponz@eprosima.com>
Date: Wed, 17 Apr 2024 15:08:45 +0200
Subject: [PATCH] Refs #20733: Document how to annotate member as key in XMl
 types

Signed-off-by: eduponz <eduardoponz@eprosima.com>
---
 code/XMLTester.xml                               | 3 +++
 docs/fastdds/xml_configuration/dynamic_types.rst | 6 ++++++
 2 files changed, 9 insertions(+)

diff --git a/code/XMLTester.xml b/code/XMLTester.xml
index 73b857ecd..bfa2b19ae 100644
--- a/code/XMLTester.xml
+++ b/code/XMLTester.xml
@@ -4358,6 +4358,9 @@
 </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"/>
diff --git a/docs/fastdds/xml_configuration/dynamic_types.rst b/docs/fastdds/xml_configuration/dynamic_types.rst
index 2732f0752..df1cc6f4e 100644
--- a/docs/fastdds/xml_configuration/dynamic_types.rst
+++ b/docs/fastdds/xml_configuration/dynamic_types.rst
@@ -60,6 +60,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
 ***************