Add PropertyPolicyQos Options section (#251)

* Refs #10994: add PropertyPolicyQos Options section Signed-off-by: JLBuenoLopez-eProsima <[email protected]> * Refs #10994: apply review suggestions Signed-off-by: JLBuenoLopez-eProsima <[email protected]>
eProsima · Mar 26, 2021 · 22593b6 · 22593b6
1 parent e588a42
commit 22593b6
Show file tree

Hide file tree

Showing 7 changed files with 80 additions and 4 deletions.
diff --git a/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst b/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst
@@ -382,10 +382,8 @@ PropertyPolicyQos
 ^^^^^^^^^^^^^^^^^
 
 This additional QoS Policy (|PropertyPolicyQos-api|) stores name/value pairs that can be used to configure certain
-DDS settings that cannot
-be configured directly using an standard QoS Policy.
-In Fast DDS, it can be used to configure the security settings (See :ref:`security` for further details of the security
-functionality).
+DDS settings that cannot be configured directly using an standard QoS Policy.
+For the complete list of settings that can be configured with this QoS Policy, please refer to :ref:`property_policies`.
 
 Example
 """""""

diff --git a/docs/fastdds/property_policies/logging.rst b/docs/fastdds/property_policies/logging.rst
@@ -0,0 +1,10 @@
+.. include:: ../../03-exports/aliases.include
+.. include:: ../../03-exports/aliases-api.include
+
+.. _property_policies_logging:
+
+Logging Module Settings
+-----------------------
+
+.. warning::
+    This section is still under work.
diff --git a/docs/fastdds/property_policies/non_consolidated_qos.rst b/docs/fastdds/property_policies/non_consolidated_qos.rst
@@ -0,0 +1,30 @@
+.. include:: ../../03-exports/aliases.include
+.. include:: ../../03-exports/aliases-api.include
+
+.. _property_policies_non_consolidated_qos:
+
+Non consolidated QoS
+--------------------
+
+The :ref:`property_policies` are used to develop new :ref:`eprosima_extensions` QoS.
+Before consolidating a new QoS Policy, it is usually set using this generic QoS Policy.
+Consequently, this section is prone to frequent updates so the user is advised to check latest changes after upgrading
+to a different release version.
+
+``PushMode`` QoS Policy
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. warning::
+    This section is still under work.
+
+Unique network flows QoS Policy
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. warning::
+    This section is still under work.
+
+Statistics Module Settings
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. warning::
+    This section is still under work.
diff --git a/docs/fastdds/property_policies/persistence.rst b/docs/fastdds/property_policies/persistence.rst
@@ -0,0 +1,10 @@
+.. include:: ../../03-exports/aliases.include
+.. include:: ../../03-exports/aliases-api.include
+
+.. _property_policies_persistence:
+
+Persistence Service Settings
+----------------------------
+
+.. warning::
+    This section is still under work.
diff --git a/docs/fastdds/property_policies/property_policies.rst b/docs/fastdds/property_policies/property_policies.rst
@@ -0,0 +1,17 @@
+.. include:: ../../03-exports/aliases.include
+.. include:: ../../03-exports/aliases-api.include
+
+.. _property_policies:
+
+PropertyPolicyQos Options
+=========================
+
+This section contains the list of :ref:`propertypolicyqos` that can be set with *Fast DDS*:
+
+.. toctree::
+    :maxdepth: 2
+
+    non_consolidated_qos.rst
+    persistence.rst
+    security.rst
+    logging.rst
diff --git a/docs/fastdds/property_policies/security.rst b/docs/fastdds/property_policies/security.rst
@@ -0,0 +1,10 @@
+.. include:: ../../03-exports/aliases.include
+.. include:: ../../03-exports/aliases-api.include
+
+.. _property_policies_security:
+
+Security Plugins Settings
+-------------------------
+
+.. warning::
+    This section is still under work.
diff --git a/docs/index.rst b/docs/index.rst
@@ -47,6 +47,7 @@
    /fastdds/statistics/statistics
    /fastdds/xml_configuration/xml_configuration
    /fastdds/env_vars/env_vars
+   /fastdds/property_policies/property_policies
    /fastdds/dynamic_types/dynamic_types
    /fastdds/use_cases/use_cases
    /fastdds/ros2/ros2