Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

EduPonz · EduPonz · commit b0bfb45d78e8 · 2024-07-02T12:54:33.000+02:00
Signed-off-by: eduponz &lt;eduardoponz@eprosima.com&gt;
diff --git a/docs/fastdds/python_api_reference/dds_pim/domain/domainparticipantqos.rst b/docs/fastdds/python_api_reference/dds_pim/domain/domainparticipantqos.rst
@@ -8,5 +8,4 @@ DomainParticipantQos
 .. autoclass:: fastdds.DomainParticipantQos
 
 
-.. TODO
-   .. autoclass:: fastdds.PARTICIPANT_QOS_DEFAULT
+.. autodata:: fastdds.PARTICIPANT_QOS_DEFAULT
diff --git a/docs/fastdds/python_api_reference/dds_pim/publisher/datawriterqos.rst b/docs/fastdds/python_api_reference/dds_pim/publisher/datawriterqos.rst
@@ -7,6 +7,6 @@ DataWriterQos
 
 .. autoclass:: fastdds.DataWriterQos
 
-.. autoclass:: fastdds.DATAWRITER_QOS_DEFAULT
+.. autodata:: fastdds.DATAWRITER_QOS_DEFAULT
 
-.. autoclass:: fastdds.DATAWRITER_QOS_USE_TOPIC_QOS
+.. autodata:: fastdds.DATAWRITER_QOS_USE_TOPIC_QOS
diff --git a/docs/fastdds/python_api_reference/dds_pim/publisher/publisherqos.rst b/docs/fastdds/python_api_reference/dds_pim/publisher/publisherqos.rst
@@ -7,4 +7,4 @@ PublisherQos
 
 .. autoclass:: fastdds.PublisherQos
 
-.. autoclass:: fastdds.PUBLISHER_QOS_DEFAULT
+.. autodata:: fastdds.PUBLISHER_QOS_DEFAULT
diff --git a/docs/fastdds/python_api_reference/dds_pim/subscriber/datareaderqos.rst b/docs/fastdds/python_api_reference/dds_pim/subscriber/datareaderqos.rst
@@ -7,6 +7,6 @@ DataReaderQos
 
 .. autoclass:: fastdds.DataReaderQos
 
-.. autoclass:: fastdds.DATAREADER_QOS_DEFAULT
+.. autodata:: fastdds.DATAREADER_QOS_DEFAULT
 
-.. autoclass:: fastdds.DATAREADER_QOS_USE_TOPIC_QOS
+.. autodata:: fastdds.DATAREADER_QOS_USE_TOPIC_QOS
diff --git a/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriberqos.rst b/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriberqos.rst
@@ -7,4 +7,4 @@ SubscriberQos
 
 .. autoclass:: fastdds.SubscriberQos
 
-.. autoclass:: fastdds.SUBSCRIBER_QOS_DEFAULT
+.. autodata:: fastdds.SUBSCRIBER_QOS_DEFAULT
diff --git a/docs/fastdds/python_api_reference/dds_pim/topic/topicqos.rst b/docs/fastdds/python_api_reference/dds_pim/topic/topicqos.rst
@@ -7,4 +7,4 @@ TopicQos
 
 .. autoclass:: fastdds.TopicQos
 
-.. autoclass:: fastdds.TOPIC_QOS_DEFAULT
+.. autodata:: fastdds.TOPIC_QOS_DEFAULT

Original file line number	Diff line number	Diff line change
`@@ -7,4 +7,4 @@ PublisherQos`
`7`	`7`
`8`	`8`	`.. autoclass:: fastdds.PublisherQos`
`9`	`9`
`10`		`-.. autoclass:: fastdds.PUBLISHER_QOS_DEFAULT`
	`10`	`+.. autodata:: fastdds.PUBLISHER_QOS_DEFAULT`
Original file line number	Diff line number	Diff line change
`@@ -7,4 +7,4 @@ SubscriberQos`
`7`	`7`
`8`	`8`	`.. autoclass:: fastdds.SubscriberQos`
`9`	`9`
`10`		`-.. autoclass:: fastdds.SUBSCRIBER_QOS_DEFAULT`
	`10`	`+.. autodata:: fastdds.SUBSCRIBER_QOS_DEFAULT`
Original file line number	Diff line number	Diff line change
`@@ -7,4 +7,4 @@ TopicQos`
`7`	`7`
`8`	`8`	`.. autoclass:: fastdds.TopicQos`
`9`	`9`
`10`		`-.. autoclass:: fastdds.TOPIC_QOS_DEFAULT`
	`10`	`+.. autodata:: fastdds.TOPIC_QOS_DEFAULT`