Refs #21745. Apply suggestions

Signed-off-by: Juan Lopez Fernandez <[email protected]>

Author: juanlofer-eprosima

include/fastdds/dds/domain/DomainParticipant.hpp

@@ -219,55 +219,55 @@ class DomainParticipantFactory
             const DomainParticipantQos& qos);
 
     /**
-     * Fills the DomainParticipantQos with the values of the XML profile.
+     * Fills the @ref DomainParticipantQos with the values of the XML profile.
      *
      * @param profile_name DomainParticipant profile name.
-     * @param qos DomainParticipantQos object where the qos is returned.
+     * @param qos @ref DomainParticipantQos object where the qos is returned.
      * @return RETCODE_OK if the profile exists. RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_participant_qos_from_profile(
             const std::string& profile_name,
             DomainParticipantQos& qos) const;
 
     /**
-     * Fills the DomainParticipantQos with the first DomainParticipant profile found in the provided XML.
+     * Fills the @ref DomainParticipantQos with the first DomainParticipant 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 DomainParticipantQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param qos @ref DomainParticipantQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_participant_qos_from_xml(
             const std::string& xml,
             DomainParticipantQos& qos) const;
 
     /**
-     * Fills the DomainParticipantQos with the DomainParticipant profile with \c profile_name to be found in the provided XML.
+     * Fills the @ref DomainParticipantQos with the DomainParticipant 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 DomainParticipantQos object where the qos is returned.
+     * @param qos @ref DomainParticipantQos object where the qos is returned.
      * @param profile_name DomainParticipant 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_participant_qos_from_xml(
             const std::string& xml,
             DomainParticipantQos& qos,
             const std::string& profile_name) const;
 
     /**
-     * Fills the DomainParticipantQos with the default DomainParticipant profile found in the provided XML (if there is).
+     * Fills the @ref DomainParticipantQos with the default DomainParticipant profile found in the provided XML (if there is).
      *
      * @note This method does not update the default participant qos (returned by \c get_default_participant_qos).
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos DomainParticipantQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param qos @ref DomainParticipantQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_default_participant_qos_from_xml(
             const std::string& xml,
             DomainParticipantQos& qos) const;
 
     /**
-     * Fills the DomainParticipantExtendedQos with the values of the XML profile.
+     * Fills the @ref DomainParticipantExtendedQos with the values of the XML profile.
      *
      * @param profile_name DomainParticipant profile name.
      * @param extended_qos DomainParticipantExtendedQos object where the domain and qos are returned.
@@ -278,46 +278,46 @@ class DomainParticipantFactory
             DomainParticipantExtendedQos& extended_qos) const;
 
     /**
-     * Fills the DomainParticipantExtendedQos with the first DomainParticipant profile found in the provided XML.
+     * Fills the @ref DomainParticipantExtendedQos with the first DomainParticipant profile found in the provided XML.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c extended_qos structure.
-     * @param extended_qos DomainParticipantExtendedQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param extended_qos @ref DomainParticipantExtendedQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_participant_extended_qos_from_xml(
             const std::string& xml,
             DomainParticipantExtendedQos& extended_qos) const;
 
     /**
-     * Fills the DomainParticipantExtendedQos with the DomainParticipant profile with \c profile_name to be found in the provided XML.
+     * Fills the @ref DomainParticipantExtendedQos with the DomainParticipant 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 extended_qos structure.
-     * @param extended_qos DomainParticipantExtendedQos object where the qos is returned.
+     * @param extended_qos @ref DomainParticipantExtendedQos object where the qos is returned.
      * @param profile_name DomainParticipant 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_participant_extended_qos_from_xml(
             const std::string& xml,
             DomainParticipantExtendedQos& extended_qos,
             const std::string& profile_name) const;
 
     /**
-     * Fills the DomainParticipantExtendedQos with the default DomainParticipant profile found in the provided XML (if there is).
+     * Fills the @ref DomainParticipantExtendedQos with the default DomainParticipant profile found in the provided XML (if there is).
      *
      * @note This method does not update the default participant extended qos.
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c extended_qos structure.
-     * @param qos DomainParticipantExtendedQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param extended_qos @ref DomainParticipantExtendedQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_default_participant_extended_qos_from_xml(
             const std::string& xml,
             DomainParticipantExtendedQos& extended_qos) const;
 
     /**
-     * Fills the DomainParticipantExtendedQos with the values of the default XML profile.
+     * Fills the @ref DomainParticipantExtendedQos with the values of the default XML profile.
      *
-     * @param extended_qos DomainParticipantExtendedQos object where the domain and qos are returned.
+     * @param extended_qos @ref DomainParticipantExtendedQos object where the domain and qos are returned.
      * @return RETCODE_OK
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_participant_extended_qos_from_default_profile(

include/fastdds/dds/domain/DomainParticipantFactory.hpp

@@ -332,21 +332,21 @@ class Publisher : public DomainEntity
             const fastdds::dds::TopicQos& topic_qos);
 
     /**
-     * Fills the DataWriterQos with the values of the XML profile.
+     * Fills the @ref DataWriterQos with the values of the XML profile.
      *
      * @param profile_name DataWriter profile name.
-     * @param qos DataWriterQos object where the qos is returned.
+     * @param qos @ref DataWriterQos object where the qos is returned.
      * @return RETCODE_OK if the profile exists. RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_datawriter_qos_from_profile(
             const std::string& profile_name,
             DataWriterQos& qos) const;
 
     /**
-     * Fills the DataWriterQos with the values of the XML profile, and also its corresponding topic name (if specified).
+     * Fills the @ref DataWriterQos with the values of the XML profile, and also its corresponding topic name (if specified).
      *
      * @param profile_name DataWriter profile name.
-     * @param qos DataWriterQos object where the qos is returned.
+     * @param qos @ref DataWriterQos object where the qos is returned.
      * @param topic_name String where the name of the topic associated to this profile is returned (if specified).
      * @return RETCODE_OK if the profile exists. RETCODE_BAD_PARAMETER otherwise.
      */
@@ -356,50 +356,50 @@ class Publisher : public DomainEntity
             std::string& topic_name) const;
 
     /**
-     * Fills the DataWriterQos with the first DataWriter profile found in the provided XML.
+     * Fills the @ref DataWriterQos with the first DataWriter 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 DataWriterQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param qos @ref DataWriterQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_datawriter_qos_from_xml(
             const std::string& xml,
             DataWriterQos& qos) const;
 
     /**
-     * Fills the DataWriterQos with the first DataWriter profile found in the provided XML, and also its corresponding topic name (if specified).
+     * Fills the @ref DataWriterQos with the first DataWriter profile found in the provided XML, and also its corresponding topic name (if specified).
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos DataWriterQos object where the qos is returned.
+     * @param qos @ref DataWriterQos object where the qos is returned.
      * @param topic_name String where the name of the topic 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_datawriter_qos_from_xml(
             const std::string& xml,
             DataWriterQos& qos,
             std::string& topic_name) const;
 
     /**
-     * Fills the DataWriterQos with the DataWriter profile with \c profile_name to be found in the provided XML.
+     * Fills the @ref DataWriterQos with the DataWriter 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 DataWriterQos object where the qos is returned.
+     * @param qos @ref DataWriterQos object where the qos is returned.
      * @param profile_name DataWriter 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_datawriter_qos_from_xml(
             const std::string& xml,
             DataWriterQos& qos,
             const std::string& profile_name) const;
 
     /**
-     * Fills the DataWriterQos with the DataWriter profile with \c profile_name to be found in the provided XML, and also its corresponding topic name (if specified).
+     * Fills the @ref DataWriterQos with the DataWriter profile with \c profile_name to be found in the provided XML, and also its corresponding topic name (if specified).
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos DataWriterQos object where the qos is returned.
+     * @param qos @ref DataWriterQos 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 profile_name DataWriter 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_datawriter_qos_from_xml(
             const std::string& xml,
@@ -408,27 +408,27 @@ class Publisher : public DomainEntity
             const std::string& profile_name) const;
 
     /**
-     * Fills the DataWriterQos with the default DataWriter profile found in the provided XML (if there is).
+     * Fills the @ref DataWriterQos with the default DataWriter profile found in the provided XML (if there is).
      *
      * @note This method does not update the default datawriter qos (returned by \c get_default_datawriter_qos).
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos DataWriterQos object where the qos is returned.
-     * @return RETCODE_OK on success. RETCODE_BAD_PARAMETER otherwise.
+     * @param qos @ref DataWriterQos object where the qos is returned.
+     * @return @ref RETCODE_OK on success. @ref RETCODE_BAD_PARAMETER otherwise.
      */
     FASTDDS_EXPORTED_API ReturnCode_t get_default_datawriter_qos_from_xml(
             const std::string& xml,
             DataWriterQos& qos) const;
 
     /**
-     * Fills the DataWriterQos with the default DataWriter profile found in the provided XML (if there is), and also its corresponding topic name (if specified).
+     * Fills the @ref DataWriterQos with the default DataWriter profile found in the provided XML (if there is), and also its corresponding topic name (if specified).
      *
      * @note This method does not update the default datawriter qos (returned by \c get_default_datawriter_qos).
      *
      * @param xml Raw XML string containing the profile to be used to fill the \c qos structure.
-     * @param qos DataWriterQos object where the qos is returned.
+     * @param qos @ref DataWriterQos object where the qos is returned.
      * @param topic_name String where the name of the topic 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_datawriter_qos_from_xml(
             const std::string& xml,