Update docs to force unlimited ResourceLimits if lower or equal to ze…

…ro (#738) Signed-off-by: JesusPoderoso <[email protected]>
eProsima · Apr 4, 2024 · 495f5a2 · 495f5a2
1 parent 5de1a15
commit 495f5a2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst b/docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst
@@ -1217,14 +1217,14 @@ List of QoS Policy data members:
  can manage across all the
  instances associated with it.
  In other words, it represents the maximum samples that the middleware can store for a DataReader or DataWriter.
- **Value 0 means infinite resources.**
+ **Value less or equal to 0 means infinite resources.**
 * |ResourceLimitsQosPolicy::max_instances-api|: Controls the maximum number of instances that a DataWriter or
  DataReader can manage.
- **Value 0 means infinite resources.**
+ **Value less or equal to 0 means infinite resources.**
 * |ResourceLimitsQosPolicy::max_samples_per_instance-api|: Controls the maximum number of samples within an instance
  that the DataWriter or
  DataReader can manage.
- **Value 0 means infinite resources.**
+ **Value less or equal to 0 means infinite resources.**
 * |ResourceLimitsQosPolicy::allocated_samples-api|: States the number of samples that will be allocated on
  initialization.
 * |ResourceLimitsQosPolicy::extra_samples-api|: States the number of extra samples that will be allocated on

diff --git a/docs/fastdds/xml_configuration/common.rst b/docs/fastdds/xml_configuration/common.rst
@@ -304,17 +304,17 @@ Please refer to :ref:`ResourceLimitsQosPolicy` for further information on Resour
 +--------------------------------+-----------------------------------------------------------+---------------+---------+
 | Name | Description | Values | Default |
 +================================+===========================================================+===============+=========+
-| ``<max_samples>`` | It must verify that: | ``uint32_t`` | 5000 |
+| ``<max_samples>`` | It must verify that: | ``int32_t``  | 5000 |
 | | ``<max_samples>`` `>=` ``<max_samples_per_instance>``. | | |
 +--------------------------------+-----------------------------------------------------------+---------------+---------+
-| ``<max_instances>`` | It defines the maximum number of instances. | ``uint32_t`` | 10 |
+| ``<max_instances>`` | It defines the maximum number of instances. | ``int32_t``  | 10 |
 +--------------------------------+-----------------------------------------------------------+---------------+---------+
-| ``<max_samples_per_instance>`` | It must verify that: :ref:`HistoryQos <hQos>` | ``uint32_t`` | 400 |
+| ``<max_samples_per_instance>`` | It must verify that: :ref:`HistoryQos <hQos>` | ``int32_t``  | 400 |
 | | ``<depth>`` `<=` ``<max_samples_per_instance>``. | | |
 +--------------------------------+-----------------------------------------------------------+---------------+---------+
-| ``<allocated_samples>`` | It controls the maximum number of samples to be stored. | ``uint32_t`` | 100 |
+| ``<allocated_samples>`` | It controls the maximum number of samples to be stored. | ``int32_t``  | 100 |
 +--------------------------------+-----------------------------------------------------------+---------------+---------+
-| ``<extra_samples>`` | The number of extra samples to allocate on the pool. | ``uint32_t`` | 1 |
+| ``<extra_samples>`` | The number of extra samples to allocate on the pool. | ``int32_t``  | 1 |
 +--------------------------------+-----------------------------------------------------------+---------------+---------+
 
 .. _ThreadSettingsType: