diff --git a/docs/03-exports/aliases-api.include b/docs/03-exports/aliases-api.include index 3d74376e1..5a78d41bd 100644 --- a/docs/03-exports/aliases-api.include +++ b/docs/03-exports/aliases-api.include @@ -137,7 +137,7 @@ .. |DomainParticipant::set_default_publisher_qos-api| replace:: :cpp:func:`set_default_publisher_qos()` .. |DomainParticipant::set_default_subscriber_qos-api| replace:: :cpp:func:`set_default_subscriber_qos()` .. |DomainParticipant::set_default_topic_qos-api| replace:: :cpp:func:`set_default_topic_qos()` -.. |DomainParticipant::get_qos-api| replace:: :cpp:func:`get_qos()` +.. |DomainParticipant::get_qos-api| replace:: :cpp:func:`DomainParticipant::get_qos()` .. |DomainParticipant::get_publisher_qos_from_profile| replace:: :cpp:func:`get_publisher_qos_from_profile()` .. |DomainParticipant::get_subscriber_qos_from_profile| replace:: :cpp:func:`get_subscriber_qos_from_profile()` .. |DomainParticipant::get_topic_qos_from_profile| replace:: :cpp:func:`get_topic_qos_from_profile()` diff --git a/docs/fastdds/dds_layer/domain/domainParticipant/domainParticipant.rst b/docs/fastdds/dds_layer/domain/domainParticipant/domainParticipant.rst index 56926998a..1706bcd91 100644 --- a/docs/fastdds/dds_layer/domain/domainParticipant/domainParticipant.rst +++ b/docs/fastdds/dds_layer/domain/domainParticipant/domainParticipant.rst @@ -52,6 +52,19 @@ Internally it contains the following |QosPolicy-api| objects: |BuiltinAttributes::discovery_config-api| within |WireProtocolConfigQos::builtin-api| (see :ref:`DS_modify_server_list`). + +.. important:: + + Upon the call to |DomainParticipantFactory::create_participant-api|, if Fast DDS is compiled with statistics support + (enabled by default, see :ref:`cmake_options`), the internal |DomainParticipantQos-api| may differ from the input + |DomainParticipantQos-api| (see :ref:`property_policies_statistics`). + This entails that applications willing to further modify the |DomainParticipantQos-api| after + |DomainParticipant-api| creation should: + + 1. Retrieve the internal |DomainParticipantQos-api| by the means of |DomainParticipant::get_qos-api|. + 2. Perform the desired modifications. + 3. Update the |DomainParticipantQos-api| by the means of |DomainParticipant::set_qos-api|. + Refer to the detailed description of each QosPolicy class for more information about their usage and default values.