Skip to content

Commit

Permalink
Refs #20291: Improve format
Browse files Browse the repository at this point in the history
Signed-off-by: cferreiragonz <carlosferreira@eprosima.com>
  • Loading branch information
cferreiragonz committed Jun 12, 2024
1 parent 40ef047 commit da71dac
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 22 deletions.
18 changes: 9 additions & 9 deletions docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -384,15 +384,15 @@ See |SendBuffersAllocationAttributes-api|.

List of structure members:

+----------------------------------------------------------------+---------------------------------------+----------------+
| Member Name | Type | Default Value |
+================================================================+=======================================+================+
| |SendBuffersAllocationAttributes::preallocated_number-api| | ``size_t`` | 0 |
+----------------------------------------------------------------+---------------------------------------+----------------+
| |SendBuffersAllocationAttributes::dynamic-api| | ``bool`` | ``false`` |
+----------------------------------------------------------------+---------------------------------------+----------------+
| |SendBuffersAllocationAttributes::network_buffers_config-api| | :ref:`resourcelimitedcontainerconfig` | (16, inf, 16) |
+------------------------------------------------------------------------+-------------------------------+----------------+
+-------------------------------------------------------------+---------------------------------------+---------------+
| Member Name | Type | Default Value |
+=============================================================+=======================================+===============+
||SendBuffersAllocationAttributes::preallocated_number-api| | ``size_t`` | 0 |
+-------------------------------------------------------------+---------------------------------------+---------------+
||SendBuffersAllocationAttributes::dynamic-api| | ``bool`` | ``false`` |
+-------------------------------------------------------------+---------------------------------------+---------------+
||SendBuffersAllocationAttributes::network_buffers_config-api|| :ref:`resourcelimitedcontainerconfig` | (16, inf, 16) |
+-------------------------------------------------------------+---------------------------------------+---------------+

* |SendBuffersAllocationAttributes::preallocated_number-api|:
This member controls the initial number of send buffers to be allocated.
Expand Down
16 changes: 3 additions & 13 deletions docs/fastdds/xml_configuration/domainparticipant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,7 @@ These elements allow the user to define the DomainParticipant configuration.
-
* - ``<allocation>``
- Configuration regarding allocation behavior. |br|
It expects a |br|
|PartAlloc|.
It expects a |PartAlloc|.
- |PartAlloc|
-
* - ``<userData>``
Expand Down Expand Up @@ -570,53 +569,44 @@ configuration.
* - Name
- Description
- Values
- Default
* - ``<remote_locators>``
- Defines the limits for the remote locators' collections. |br|
See :ref:`remotelocatorsallocationattributes`.
- :ref:`remote_locators_allocations`
-
* - ``<total_participants>``
- DomainParticipant :ref:`CommonAlloc` to specify the |br|
total number of DomainParticipants in the domain |br|
(local and remote). See |br|
:ref:`ResourceLimitedContainerConfig`.
- :ref:`CommonAlloc`
-
* - ``<total_readers>``
- DomainParticipant :ref:`CommonAlloc` to specify the |br|
total number of DataReader on each DomainParticipant |br|
(local and remote). See |br|
:ref:`ResourceLimitedContainerConfig`.
- :ref:`CommonAlloc`
-
* - ``<total_writers>``
- DomainParticipant :ref:`CommonAlloc` related to the |br|
total number of DataWriters on each DomainParticipant |br|
(local and remote).
See :ref:`resourcelimitedcontainerconfig`.
- :ref:`CommonAlloc`
-
* - ``<max_partitions>``
- Maximum size of the partitions submessage. |br|
Set to zero for no limit.
- ``uint32_t``
-
* - ``<max_user_data>``
- Maximum size of the user data submessage. |br|
Set to zero for no limit.
- ``uint32_t``
-
* - ``<max_properties>``
- Maximum size of the properties submessage. |br|
Set to zero for no limit.
- ``uint32_t``
-
* - ``<send_buffers>``
- Allocation behaviour for the send buffer |br|
manager.
- :ref:`SendBuffers`
-

**Example**

Expand Down Expand Up @@ -672,8 +662,8 @@ Send buffers
- ``uint32_t``
- 0
* - ``<dynamic>``
- Whether the number of send buffers is allowed to grow. |br|
See :ref:`sendbuffersallocationattributes`.
- Whether the number of send buffers is allowed to |br|
grow. See :ref:`sendbuffersallocationattributes`.
- ``bool``
- false
* - ``<network_buffers_config>``
Expand Down

0 comments on commit da71dac

Please sign in to comment.