From c6ef20ef9bd4a75883296ec0371ab22a526c2919 Mon Sep 17 00:00:00 2001 From: Juanjo Garcia Date: Thu, 19 Dec 2024 15:25:54 +0100 Subject: [PATCH] Unified the QOS_DEFAULT format in text Signed-off-by: Juanjo Garcia --- .../domain/domainParticipant/domainParticipant.rst | 6 +++--- .../dds_layer/publisher/dataWriter/createDataWriter.rst | 4 ++-- .../fastdds/dds_layer/publisher/dataWriter/dataWriter.rst | 8 ++++---- .../dds_layer/publisher/publisher/createPublisher.rst | 2 +- docs/fastdds/dds_layer/publisher/publisher/publisher.rst | 6 +++--- .../dds_layer/subscriber/dataReader/createDataReader.rst | 4 ++-- .../dds_layer/subscriber/dataReader/dataReader.rst | 6 +++--- .../dds_layer/subscriber/sampleInfo/sampleInfo.rst | 2 +- .../dds_layer/subscriber/subscriber/createSubscriber.rst | 2 +- .../dds_layer/subscriber/subscriber/subscriber.rst | 6 +++--- docs/fastdds/dds_layer/topic/topic/createTopic.rst | 2 +- docs/fastdds/dds_layer/topic/topic/topic.rst | 6 +++--- 12 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/fastdds/dds_layer/domain/domainParticipant/domainParticipant.rst b/docs/fastdds/dds_layer/domain/domainParticipant/domainParticipant.rst index 6701f2e6b..9844511f4 100644 --- a/docs/fastdds/dds_layer/domain/domainParticipant/domainParticipant.rst +++ b/docs/fastdds/dds_layer/domain/domainParticipant/domainParticipant.rst @@ -117,7 +117,7 @@ Default DomainParticipantQos The default DomainParticipantQos refers to the value returned by the |DomainParticipantFactory::get_default_participant_qos-api| member function on the :ref:`dds_layer_domainParticipantFactory` singleton. -The special value ``PARTICIPANT_QOS_DEFAULT`` can be used as QoS argument on +The special value :code:`PARTICIPANT_QOS_DEFAULT` can be used as QoS argument on |DomainParticipantFactory::create_participant-api| or |DomainParticipant::set_qos-api| member functions to indicate that the current default DomainParticipantQos should be used. @@ -137,7 +137,7 @@ DomainParticipant instances. :dedent: 8 |DomainParticipantFactory::set_default_participant_qos-api| -member function also accepts the value ``PARTICIPANT_QOS_DEFAULT`` +member function also accepts the value :code:`PUBLISHER_QOS_DEFAULT` as input argument. This will reset the current default DomainParticipantQos to the default constructed value |DomainParticipantQos::DomainParticipantQos-api|. @@ -149,7 +149,7 @@ This will reset the current default DomainParticipantQos to the default construc :dedent: 8 .. note:: - The value ``PARTICIPANT_QOS_DEFAULT`` has different meaning depending on where it is used: + The value :code:`PUBLISHER_QOS_DEFAULT` has different meaning depending on where it is used: * On |DomainParticipantFactory::create_participant-api| and |DomainParticipant::set_qos-api| it refers to the default DomainParticipantQos as returned by |DomainParticipantFactory::get_default_participant_qos-api|. diff --git a/docs/fastdds/dds_layer/publisher/dataWriter/createDataWriter.rst b/docs/fastdds/dds_layer/publisher/dataWriter/createDataWriter.rst index b64445848..3bde4160b 100644 --- a/docs/fastdds/dds_layer/publisher/dataWriter/createDataWriter.rst +++ b/docs/fastdds/dds_layer/publisher/dataWriter/createDataWriter.rst @@ -15,9 +15,9 @@ Mandatory arguments are: * A :ref:`dds_layer_topic_topic` bound to the data type that will be transmitted. * The :ref:`dds_layer_publisher_dataWriterQos` describing the behavior of the DataWriter. - If the provided value is :class:`DATAWRITER_QOS_DEFAULT`, + If the provided value is :code:`DATAWRITER_QOS_DEFAULT`, the value of the :ref:`dds_layer_defaultDataWriterQos` is used. - If the provided value is :class:`DATAWRITER_QOS_USE_TOPIC_QOS`, + If the provided value is :code:`DATAWRITER_QOS_USE_TOPIC_QOS`, the values of the default QoS and the provided TopicQoS are used, whereby any policy that is set on the TopicQoS overrides the corresponding policy on the default QoS. diff --git a/docs/fastdds/dds_layer/publisher/dataWriter/dataWriter.rst b/docs/fastdds/dds_layer/publisher/dataWriter/dataWriter.rst index fb8e5d40d..6aadd6f02 100644 --- a/docs/fastdds/dds_layer/publisher/dataWriter/dataWriter.rst +++ b/docs/fastdds/dds_layer/publisher/dataWriter/dataWriter.rst @@ -91,7 +91,7 @@ default values. .. note:: Reliability kind (whether the publication is reliable or best effort) is not mutable. - However, the ``max_blocking_time`` data member of |ReliabilityQosPolicy| can be modified any time. + However, the :code:`max_blocking_time` data member of |ReliabilityQosPolicy| can be modified any time. .. note:: Not all data members of RTPSReliableWriterQos are mutable, please refer to |RTPSReliableWriterQos| @@ -114,7 +114,7 @@ Default DataWriterQos The default :ref:`dds_layer_publisher_dataWriterQos` refers to the value returned by the |Publisher::get_default_datawriter_qos-api| member function on the Publisher instance. -The special value :class:`DATAWRITER_QOS_DEFAULT` can be used as QoS argument on |Publisher::create_datawriter-api| +The special value :code:`DATAWRITER_QOS_DEFAULT` can be used as QoS argument on |Publisher::create_datawriter-api| or |DataWriter::set_qos-api| member functions to indicate that the current default DataWriterQos should be used. @@ -131,7 +131,7 @@ DataWriter instances. :end-before: //! :dedent: 8 -|Publisher::set_default_datawriter_qos-api| member function also accepts the special value ``DATAWRITER_QOS_DEFAULT`` +|Publisher::set_default_datawriter_qos-api| member function also accepts the special value :code:`DATAWRITER_QOS_DEFAULT` as input argument. This will reset the current default DataWriterQos to default constructed value |DataWriterQos::DataWriterQos-api|. @@ -143,7 +143,7 @@ value |DataWriterQos::DataWriterQos-api|. :dedent: 8 .. note:: - The value ``DATAWRITER_QOS_DEFAULT`` has different meaning depending on where it is used: + The value :code:`DATAWRITER_QOS_DEFAULT` has different meaning depending on where it is used: * On |Publisher::create_datawriter-api| and |DataWriter::set_qos-api| it refers to the default DataWriterQos as returned by |Publisher::get_default_datawriter_qos-api|. diff --git a/docs/fastdds/dds_layer/publisher/publisher/createPublisher.rst b/docs/fastdds/dds_layer/publisher/publisher/createPublisher.rst index 979e7e901..1c3c2266c 100644 --- a/docs/fastdds/dds_layer/publisher/publisher/createPublisher.rst +++ b/docs/fastdds/dds_layer/publisher/publisher/createPublisher.rst @@ -13,7 +13,7 @@ DomainParticipant instance, that acts as a factory for the Publisher. Mandatory arguments are: * The :ref:`dds_layer_publisher_publisherQos` describing the behavior of the Publisher. - If the provided value is :class:`PUBLISHER_QOS_DEFAULT`, + If the provided value is :code:`PUBLISHER_QOS_DEFAULT`, the value of the :ref:`dds_layer_defaultPublisherQos` is used. Optional arguments are: diff --git a/docs/fastdds/dds_layer/publisher/publisher/publisher.rst b/docs/fastdds/dds_layer/publisher/publisher/publisher.rst index f4ad62ac1..876dc0ac3 100644 --- a/docs/fastdds/dds_layer/publisher/publisher/publisher.rst +++ b/docs/fastdds/dds_layer/publisher/publisher/publisher.rst @@ -58,7 +58,7 @@ Default PublisherQos The default :ref:`dds_layer_publisher_publisherQos` refers to the value returned by the |DomainParticipant::get_default_publisher_qos-api| member function on the DomainParticipant instance. -The special value :class:`PUBLISHER_QOS_DEFAULT` can be used as QoS argument on +The special value :code:`PUBLISHER_QOS_DEFAULT` can be used as QoS argument on |DomainParticipant::create_publisher-api| or |Publisher::set_qos-api| member functions to indicate that the current default PublisherQos should be used. @@ -76,7 +76,7 @@ Modifying the default PublisherQos will not affect already existing :dedent: 8 |DomainParticipant::set_default_publisher_qos-api| member function also accepts the special value -``PUBLISHER_QOS_DEFAULT`` as input argument. +:code:`PUBLISHER_QOS_DEFAULT` as input argument. This will reset the current default PublisherQos to default constructed value |PublisherQos::PublisherQos-api|. @@ -87,7 +87,7 @@ value |PublisherQos::PublisherQos-api|. :dedent: 8 .. note:: - The value ``PUBLISHER_QOS_DEFAULT`` has different meaning depending on where it is used: + The value :code:`PUBLISHER_QOS_DEFAULT` has different meaning depending on where it is used: * On |DomainParticipant::create_publisher-api| and |Publisher::set_qos-api| it refers to the default :ref:`dds_layer_publisher_publisherQos`. diff --git a/docs/fastdds/dds_layer/subscriber/dataReader/createDataReader.rst b/docs/fastdds/dds_layer/subscriber/dataReader/createDataReader.rst index 3c7550671..a82efc535 100644 --- a/docs/fastdds/dds_layer/subscriber/dataReader/createDataReader.rst +++ b/docs/fastdds/dds_layer/subscriber/dataReader/createDataReader.rst @@ -15,9 +15,9 @@ Mandatory arguments are: * A :ref:`dds_layer_topic_topic` bound to the data type that will be transmitted. * The :ref:`dds_layer_subscriber_dataReaderQos` describing the behavior of the DataReader. - If the provided value is :class:`DATAREADER_QOS_DEFAULT`, + If the provided value is :code:`DATAREADER_QOS_DEFAULT`, the value of the :ref:`dds_layer_defaultDataReaderQos` is used. - If the provided value is :class:`DATAREADER_QOS_USE_TOPIC_QOS`, + If the provided value is :code:`DATAREADER_QOS_USE_TOPIC_QOS`, the values of the default QoS and the provided TopicQoS are used, whereby any policy that is set on the TopicQoS overrides the corresponding policy on the default QoS. diff --git a/docs/fastdds/dds_layer/subscriber/dataReader/dataReader.rst b/docs/fastdds/dds_layer/subscriber/dataReader/dataReader.rst index e378c30a5..979b593ae 100644 --- a/docs/fastdds/dds_layer/subscriber/dataReader/dataReader.rst +++ b/docs/fastdds/dds_layer/subscriber/dataReader/dataReader.rst @@ -120,7 +120,7 @@ Default DataReaderQos The default DataReaderQos refers to the value returned by the |Subscriber::get_default_datareader_qos-api| member function on the :ref:`dds_layer_subscriber_subscriber` instance. -The special value ``DATAREADER_QOS_DEFAULT`` can be used as QoS argument on +The special value :code:`DATAREADER_QOS_DEFAULT` can be used as QoS argument on |Subscriber::create_datareader-api| or |DataReader::set_qos-api| member functions to indicate that the current default DataReaderQos should be used. @@ -140,7 +140,7 @@ Modifying the default DataReaderQos will not affect already existing :dedent: 8 |Subscriber::set_default_datareader_qos-api| member function also accepts -the special value ``DATAREADER_QOS_DEFAULT`` as input argument. +the special value :code:`DATAREADER_QOS_DEFAULT` as input argument. This will reset the current default DataReaderQos to default constructed value |DataReaderQos::DataReaderQos-api|. @@ -151,7 +151,7 @@ value |DataReaderQos::DataReaderQos-api|. :dedent: 8 .. note:: - The value ``DATAREADER_QOS_DEFAULT`` has different meaning depending on where it is used: + The value :code:`DATAREADER_QOS_DEFAULT` has different meaning depending on where it is used: * On |Subscriber::create_datareader-api| and |DataReader::set_qos-api| it refers to the default diff --git a/docs/fastdds/dds_layer/subscriber/sampleInfo/sampleInfo.rst b/docs/fastdds/dds_layer/subscriber/sampleInfo/sampleInfo.rst index 859ab478b..e0defd291 100644 --- a/docs/fastdds/dds_layer/subscriber/sampleInfo/sampleInfo.rst +++ b/docs/fastdds/dds_layer/subscriber/sampleInfo/sampleInfo.rst @@ -8,7 +8,7 @@ SampleInfo When a sample is retrieved from the :ref:`dds_layer_subscriber_dataReader`, in addition to the sample data, a |SampleInfo-api| instance is returned. -This object contains additional information that complements the returned data value and helps on it interpretation. +This object contains additional information that complements the returned data value and helps on its interpretation. For example, if the :ref:`dds_layer_subscriber_sampleInfo_validdata` value is ``false``, the DataReader is not informing the application about a new value in the data instance, but a change on its status, and the returned data value must be discarded. diff --git a/docs/fastdds/dds_layer/subscriber/subscriber/createSubscriber.rst b/docs/fastdds/dds_layer/subscriber/subscriber/createSubscriber.rst index 343b571aa..c4429d837 100644 --- a/docs/fastdds/dds_layer/subscriber/subscriber/createSubscriber.rst +++ b/docs/fastdds/dds_layer/subscriber/subscriber/createSubscriber.rst @@ -13,7 +13,7 @@ DomainParticipant instance, that acts as a factory for the Subscriber. Mandatory arguments are: * The :ref:`dds_layer_subscriber_subscriberQos` describing the behavior of the Subscriber. - If the provided value is :class:`SUBSCRIBER_QOS_DEFAULT`, + If the provided value is :code:`SUBSCRIBER_QOS_DEFAULT`, the value of the :ref:`dds_layer_defaultSubscriberQos` is used. Optional arguments are: diff --git a/docs/fastdds/dds_layer/subscriber/subscriber/subscriber.rst b/docs/fastdds/dds_layer/subscriber/subscriber/subscriber.rst index e20caeb68..c91e4efba 100644 --- a/docs/fastdds/dds_layer/subscriber/subscriber/subscriber.rst +++ b/docs/fastdds/dds_layer/subscriber/subscriber/subscriber.rst @@ -59,7 +59,7 @@ Default SubscriberQos The default :ref:`dds_layer_subscriber_subscriberQos` refers to the value returned by the |DomainParticipant::get_default_subscriber_qos-api| member function on the :ref:`dds_layer_domainParticipant` instance. -The special value ``SUBSCRIBER_QOS_DEFAULT`` can be used as QoS argument on +The special value :code:`SUBSCRIBER_QOS_DEFAULT` can be used as QoS argument on |DomainParticipant::create_subscriber-api| or |Subscriber::set_qos-api| member functions to indicate that the current default SubscriberQos should be used. @@ -79,7 +79,7 @@ Subscriber instances. :dedent: 8 |DomainParticipant::set_default_subscriber_qos-api| member function also accepts -the special value ``SUBSCRIBER_QOS_DEFAULT`` as input argument. +the special value :code:`SUBSCRIBER_QOS_DEFAULT` as input argument. This will reset the current default SubscriberQos to default constructed value |SubscriberQos::SubscriberQos-api|. @@ -90,7 +90,7 @@ value |SubscriberQos::SubscriberQos-api|. :dedent: 8 .. note:: - The value ``SUBSCRIBER_QOS_DEFAULT`` has different meaning depending on where it is used: + The value :code:`SUBSCRIBER_QOS_DEFAULT` has different meaning depending on where it is used: * On |DomainParticipant::create_subscriber-api| and |Subscriber::set_qos-api| it refers to the default SubscriberQos as returned by |DomainParticipant::get_default_subscriber_qos-api|. diff --git a/docs/fastdds/dds_layer/topic/topic/createTopic.rst b/docs/fastdds/dds_layer/topic/topic/createTopic.rst index c08540e36..2d5ede224 100644 --- a/docs/fastdds/dds_layer/topic/topic/createTopic.rst +++ b/docs/fastdds/dds_layer/topic/topic/createTopic.rst @@ -17,7 +17,7 @@ Mandatory arguments are: * The name of the registered :ref:`data type` that will be transmitted. * The :ref:`dds_layer_topic_topicQos` describing the behavior of the Topic. - If the provided value is :class:`TOPIC_QOS_DEFAULT`, + If the provided value is :code:`TOPIC_QOS_DEFAULT`, the value of the :ref:`dds_layer_defaultTopicQos` is used. Optional arguments are: diff --git a/docs/fastdds/dds_layer/topic/topic/topic.rst b/docs/fastdds/dds_layer/topic/topic/topic.rst index bec7a1290..4185425df 100644 --- a/docs/fastdds/dds_layer/topic/topic/topic.rst +++ b/docs/fastdds/dds_layer/topic/topic/topic.rst @@ -84,7 +84,7 @@ Default TopicQos The default :ref:`dds_layer_topic_topicQos` refers to the value returned by the |DomainParticipant::get_default_topic_qos-api| member function on the :ref:`dds_layer_domainParticipant` instance. -The special value ``TOPIC_QOS_DEFAULT`` can be used as QoS argument on |DomainParticipant::create_topic-api| +The special value :code:`TOPIC_QOS_DEFAULT` can be used as QoS argument on |DomainParticipant::create_topic-api| or |Topic::set_qos-api| member functions to indicate that the current default TopicQos should be used. @@ -101,7 +101,7 @@ instances. :end-before: //! :dedent: 8 -|DomainParticipant::get_default_topic_qos-api| member function also accepts the value ``TOPIC_QOS_DEFAULT`` +|DomainParticipant::get_default_topic_qos-api| member function also accepts the value :code:`TOPIC_QOS_DEFAULT` as input argument. This will reset the current default TopicQos to default constructed value |TopicQos::TopicQos-api|. @@ -113,7 +113,7 @@ value |TopicQos::TopicQos-api|. :dedent: 8 .. note:: - The value ``TOPIC_QOS_DEFAULT`` has different meaning depending on where it is used: + The value :code:`TOPIC_QOS_DEFAULT` has different meaning depending on where it is used: * On |DomainParticipant::create_topic-api| and |Topic::set_qos-api| it refers to the default TopicQos as returned by |DomainParticipant::get_default_topic_qos-api|.