diff --git a/include/fastdds/dds/core/policy/QosPolicies.hpp b/include/fastdds/dds/core/policy/QosPolicies.hpp index 6e37db732b9..b28c77f6137 100644 --- a/include/fastdds/dds/core/policy/QosPolicies.hpp +++ b/include/fastdds/dds/core/policy/QosPolicies.hpp @@ -2797,8 +2797,10 @@ class TransportConfigQos : public QosPolicy //! Thread settings for the builtin transports reception threads rtps::ThreadSettings builtin_transports_reception_threads_; - /*! Maximum message size used to avoid fragmentation, set ONLY in LARGE_DATA. If this value is - * not zero, the network factory will allow the initialization of UDP transports with maxMessageSize + /*! + * @brief Maximum message size used to avoid fragmentation, set ONLY in LARGE_DATA. + * + * If this value is not zero, the network factory will allow the initialization of UDP transports with maxMessageSize * higher than 65500K. */ uint32_t max_msg_size_no_frag; diff --git a/include/fastdds/dds/domain/DomainParticipant.hpp b/include/fastdds/dds/domain/DomainParticipant.hpp index 8ca6db4463d..fb6b3be24d2 100644 --- a/include/fastdds/dds/domain/DomainParticipant.hpp +++ b/include/fastdds/dds/domain/DomainParticipant.hpp @@ -684,6 +684,7 @@ class DomainParticipant : public Entity * * @param[out] participant_handles Reference to the vector where discovered participants will be returned * @return RETCODE_OK if everything correct, error code otherwise + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t get_discovered_participants( @@ -695,6 +696,7 @@ class DomainParticipant : public Entity * @param[out] participant_data Reference to the ParticipantBuiltinTopicData object to return the data * @param participant_handle InstanceHandle of DomainParticipant to retrieve the data from * @return RETCODE_OK if everything correct, PRECONDITION_NOT_MET if participant does not exist + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t get_discovered_participant_data( @@ -706,6 +708,7 @@ class DomainParticipant : public Entity * * @param[out] topic_handles Reference to the vector where discovered topics will be returned * @return RETCODE_OK if everything correct, error code otherwise + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t get_discovered_topics( diff --git a/include/fastdds/dds/publisher/DataWriter.hpp b/include/fastdds/dds/publisher/DataWriter.hpp index 52f6d560065..58e0c9b64c0 100644 --- a/include/fastdds/dds/publisher/DataWriter.hpp +++ b/include/fastdds/dds/publisher/DataWriter.hpp @@ -483,6 +483,7 @@ class DataWriter : public DomainEntity * @param[out] subscription_data subscription data struct * @param subscription_handle InstanceHandle_t of the subscription * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t get_matched_subscription_data( @@ -494,6 +495,7 @@ class DataWriter : public DomainEntity * * @param[out] subscription_handles Vector where the InstanceHandle_t are returned * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t get_matched_subscriptions( diff --git a/include/fastdds/dds/publisher/Publisher.hpp b/include/fastdds/dds/publisher/Publisher.hpp index 444131a0b57..867d15134b7 100644 --- a/include/fastdds/dds/publisher/Publisher.hpp +++ b/include/fastdds/dds/publisher/Publisher.hpp @@ -215,6 +215,7 @@ class Publisher : public DomainEntity * @brief Indicates to FastDDS that the contained DataWriters are about to be modified * * @return RETCODE_OK if successful, an error code otherwise + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t suspend_publications(); @@ -223,6 +224,7 @@ class Publisher : public DomainEntity * @brief Indicates to FastDDS that the modifications to the DataWriters are complete. * * @return RETCODE_OK if successful, an error code otherwise + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t resume_publications(); @@ -231,6 +233,7 @@ class Publisher : public DomainEntity * @brief Signals the beginning of a set of coherent cache changes using the Datawriters attached to the publisher * * @return RETCODE_OK if successful, an error code otherwise + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t begin_coherent_changes(); @@ -239,6 +242,7 @@ class Publisher : public DomainEntity * @brief Signals the end of a set of coherent cache changes * * @return RETCODE_OK if successful, an error code otherwise + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t end_coherent_changes(); @@ -320,6 +324,8 @@ class Publisher : public DomainEntity * @param[out] writer_qos * @param[in] topic_qos * @return RETCODE_OK if successful, an error code otherwise + * + * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API static ReturnCode_t copy_from_topic_qos( fastdds::dds::DataWriterQos& writer_qos, diff --git a/include/fastdds/dds/subscriber/DataReader.hpp b/include/fastdds/dds/subscriber/DataReader.hpp index da723d0d6d4..107800c1e5f 100644 --- a/include/fastdds/dds/subscriber/DataReader.hpp +++ b/include/fastdds/dds/subscriber/DataReader.hpp @@ -133,6 +133,7 @@ class DataReader : public DomainEntity * * @param[in] max_wait Max blocking time for this operation. * @return RETCODE_OK if there is new unread message, RETCODE_TIMEOUT if timeout + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t wait_for_historical_data( @@ -761,6 +762,7 @@ class DataReader : public DomainEntity * @param[in] handle * * @return Any of the standard return codes. + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t get_key_value( @@ -973,6 +975,7 @@ class DataReader : public DomainEntity * @param[out] publication_data publication data struct * @param publication_handle InstanceHandle_t of the publication * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t get_matched_publication_data( @@ -984,6 +987,7 @@ class DataReader : public DomainEntity * * @param[out] publication_handles Vector where the InstanceHandle_t are returned * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t get_matched_publications( diff --git a/include/fastdds/dds/subscriber/Subscriber.hpp b/include/fastdds/dds/subscriber/Subscriber.hpp index 705ec05bc7c..15d900c8d95 100644 --- a/include/fastdds/dds/subscriber/Subscriber.hpp +++ b/include/fastdds/dds/subscriber/Subscriber.hpp @@ -232,6 +232,7 @@ class Subscriber : public DomainEntity * @param view_states Vector of ViewStateKind * @param instance_states Vector of InstanceStateKind * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t get_datareaders( @@ -252,6 +253,7 @@ class Subscriber : public DomainEntity * attached to the Subscriber. * * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t begin_access(); @@ -261,6 +263,7 @@ class Subscriber : public DomainEntity * the Subscriber. * * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API ReturnCode_t end_access(); @@ -358,6 +361,8 @@ class Subscriber : public DomainEntity * @param[in, out] reader_qos * @param[in] topic_qos * @return RETCODE_OK if successful, an error code otherwise + * + * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ FASTDDS_EXPORTED_API static ReturnCode_t copy_from_topic_qos( DataReaderQos& reader_qos,