Apply suggestions from code review

Co-authored-by: Ricardo González <[email protected]>

Author: juanlofer-eprosima

include/fastdds/dds/domain/DomainParticipant.hpp

@@ -548,37 +548,37 @@ class DomainParticipant : public Entity
             PublisherQos& qos) const;
 
     /**
-     * Fills the PublisherQos with the first publisher profile found in the provided XML.
+     * Fills the @ref PublisherQos with the first publisher profile found in the provided XML.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos PublisherQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param qos @ref PublisherQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_publisher_qos_from_xml(
             const std::string& xml,
             PublisherQos& qos) const;
 
     /**
-     * Fills the PublisherQos with the publisher profile with \c profile_name to be found in the provided XML.
+     * Fills the @ref PublisherQos with the publisher profile with \c profile_name to be found in the provided XML.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos PublisherQos object where the qos is returned.
+     * @param qos @ref PublisherQos object where the qos is returned.
      * @param profile_name Publisher profile name.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_publisher_qos_from_xml(
             const std::string& xml,
             PublisherQos& qos,
             const std::string& profile_name) const;
 
     /**
-     * Fills the PublisherQos with the default publisher profile found in the provided XML (if there is).
+     * Fills the @ref PublisherQos with the default publisher profile found in the provided XML (if there is).
      *
      * @note This method does not update the default publisher qos (returned by \c get_default_publisher_qos).
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos PublisherQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param qos @ref PublisherQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_default_publisher_qos_from_xml(
             const std::string& xml,
@@ -639,37 +639,37 @@ class DomainParticipant : public Entity
             SubscriberQos& qos) const;
 
     /**
-     * Fills the SubscriberQos with the first subscriber profile found in the provided XML.
+     * Fills the @ref SubscriberQos with the first subscriber profile found in the provided XML.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos SubscriberQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param qos @ref SubscriberQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_subscriber_qos_from_xml(
             const std::string& xml,
             SubscriberQos& qos) const;
 
     /**
-     * Fills the SubscriberQos with the subscriber profile with \c profile_name to be found in the provided XML.
+     * Fills the @ref SubscriberQos with the subscriber profile with \c profile_name to be found in the provided XML.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos SubscriberQos object where the qos is returned.
+     * @param qos @ref SubscriberQos object where the qos is returned.
      * @param profile_name Subscriber profile name.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_subscriber_qos_from_xml(
             const std::string& xml,
             SubscriberQos& qos,
             const std::string& profile_name) const;
 
     /**
-     * Fills the SubscriberQos with the default subscriber profile found in the provided XML (if there is).
+     * Fills the @ref SubscriberQos with the default subscriber profile found in the provided XML (if there is).
      *
      * @note This method does not update the default subscriber qos (returned by \c get_default_subscriber_qos).
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos SubscriberQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param qos @ref SubscriberQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_default_subscriber_qos_from_xml(
             const std::string& xml,
@@ -730,13 +730,13 @@ class DomainParticipant : public Entity
             TopicQos& qos) const;
 
     /**
-     * Fills the TopicQos with the values of the XML profile, and also its corresponding topic and data type names (if specified).
+     * Fills the @ref TopicQos with the values of the XML profile, and also its corresponding topic and data type names (if specified).
      *
      * @param profile_name Topic profile name.
-     * @param qos TopicQos object where the qos is returned.
+     * @param qos @ref TopicQos object where the qos is returned.
      * @param topic_name String where the name of the topic associated to this profile is returned (if specified).
      * @param topic_data_type String where the name of the topic data type associated to this profile is returned (if specified).
-     * @return RETCODE_OK if the profile exists. RETCODE_BAD_PARAMETER otherwise.
+     * @return @ref RETCODE_OK if the profile exists. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_topic_qos_from_profile(
             const std::string& profile_name,
@@ -745,24 +745,24 @@ class DomainParticipant : public Entity
             std::string& topic_data_type) const;
 
     /**
-     * Fills the TopicQos with the first topic profile found in the provided XML.
+     * Fills the @ref TopicQos with the first topic profile found in the provided XML.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos TopicQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param qos @ref TopicQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_topic_qos_from_xml(
             const std::string& xml,
             TopicQos& qos) const;
 
     /**
-     * Fills the TopicQos with the first topic profile found in the provided XML, and also its corresponding topic and data type names (if specified).
+     * Fills the @ref TopicQos with the first topic profile found in the provided XML, and also its corresponding topic and data type names (if specified).
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos TopicQos object where the qos is returned.
+     * @param qos @ref TopicQos object where the qos is returned.
      * @param topic_name String where the name of the topic associated to this profile is returned (if specified).
      * @param topic_data_type String where the name of the topic data type associated to this profile is returned (if specified).
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_topic_qos_from_xml(
             const std::string& xml,
@@ -771,27 +771,27 @@ class DomainParticipant : public Entity
             std::string& topic_data_type) const;
 
     /**
-     * Fills the TopicQos with the topic profile with \c profile_name to be found in the provided XML.
+     * Fills the @ref TopicQos with the topic profile with \c profile_name to be found in the provided XML.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos TopicQos object where the qos is returned.
+     * @param qos @ref TopicQos object where the qos is returned.
      * @param profile_name Topic profile name.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_topic_qos_from_xml(
             const std::string& xml,
             TopicQos& qos,
             const std::string& profile_name) const;
 
     /**
-     * Fills the TopicQos with the topic profile with \c profile_name to be found in the provided XML, and also its corresponding topic and data type names (if specified).
+     * Fills the @ref TopicQos with the topic profile with \c profile_name to be found in the provided XML, and also its corresponding topic and data type names (if specified).
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos TopicQos object where the qos is returned.
+     * @param qos @ref TopicQos object where the qos is returned.
      * @param topic_name String where the name of the topic associated to this profile is returned (if specified).
      * @param topic_data_type String where the name of the topic data type associated to this profile is returned (if specified).
      * @param profile_name Topic profile name.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_topic_qos_from_xml(
             const std::string& xml,
@@ -814,15 +814,15 @@ class DomainParticipant : public Entity
             TopicQos& qos) const;
 
     /**
-     * Fills the TopicQos with the default topic profile found in the provided XML (if there is), and also its corresponding topic and data type names (if specified).
+     * Fills the @ref TopicQos with the default topic profile found in the provided XML (if there is), and also its corresponding topic and data type names (if specified).
      *
      * @note This method does not update the default topic qos (returned by \c get_default_topic_qos).
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos TopicQos object where the qos is returned.
+     * @param qos @ref TopicQos object where the qos is returned.
      * @param topic_name String where the name of the topic associated to this profile is returned (if specified).
      * @param topic_data_type String where the name of the topic data type associated to this profile is returned (if specified).
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_default_topic_qos_from_xml(
             const std::string& xml,
@@ -842,37 +842,37 @@ class DomainParticipant : public Entity
             ReplierQos& qos) const;
 
     /**
-     * Fills the ReplierQos with the first replier profile found in the provided XML.
+     * Fills the @ref ReplierQos with the first replier profile found in the provided XML.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos ReplierQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param qos @ref ReplierQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_replier_qos_from_xml(
             const std::string& xml,
             ReplierQos& qos) const;
 
     /**
-     * Fills the ReplierQos with the replier profile with \c profile_name to be found in the provided XML.
+     * Fills the @ref ReplierQos with the replier profile with \c profile_name to be found in the provided XML.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos ReplierQos object where the qos is returned.
+     * @param qos @ref ReplierQos object where the qos is returned.
      * @param profile_name Replier profile name.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_replier_qos_from_xml(
             const std::string& xml,
             ReplierQos& qos,
             const std::string& profile_name) const;
 
     /**
-     * Fills the ReplierQos with the default replier profile found in the provided XML (if there is).
+     * Fills the @ref ReplierQos with the default replier profile found in the provided XML (if there is).
      *
      * @note This method does not update the default replier qos.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos ReplierQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param qos @ref ReplierQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_default_replier_qos_from_xml(
             const std::string& xml,
@@ -890,37 +890,37 @@ class DomainParticipant : public Entity
             RequesterQos& qos) const;
 
     /**
-     * Fills the RequesterQos with the first requester profile found in the provided XML.
+     * Fills the @ref RequesterQos with the first requester profile found in the provided XML.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos RequesterQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param qos @ref RequesterQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_requester_qos_from_xml(
             const std::string& xml,
             RequesterQos& qos) const;
 
     /**
-     * Fills the RequesterQos with the requester profile with \c profile_name to be found in the provided XML.
+     * Fills the @ref RequesterQos with the requester profile with \c profile_name to be found in the provided XML.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos RequesterQos object where the qos is returned.
+     * @param qos @ref RequesterQos object where the qos is returned.
      * @param profile_name Requester profile name.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_requester_qos_from_xml(
             const std::string& xml,
             RequesterQos& qos,
             const std::string& profile_name) const;
 
     /**
-     * Fills the RequesterQos with the default requester profile found in the provided XML (if there is).
+     * Fills the @ref RequesterQos with the default requester profile found in the provided XML (if there is).
      *
      * @note This method does not update the default requester qos.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos RequesterQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param qos @ref RequesterQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_default_requester_qos_from_xml(
             const std::string& xml,