From f49c0dba2ab4eae40daf547bf121d6c68ceb9e94 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Fri, 8 Mar 2024 08:31:05 +0100 Subject: [PATCH] Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 (#4376) (#4392) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mario Dominguez Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com> --- include/fastrtps/config/doxygen_modules.h | 10 +++++++++ .../fastrtps/types/AnnotationParameterValue.h | 7 +++--- include/fastrtps/types/TypeIdentifierTypes.h | 22 +++++++++---------- include/fastrtps/types/TypeObjectHashId.h | 2 +- .../fastrtps/xmlparser/XMLEndpointParser.h | 2 +- .../fastrtps/xmlparser/XMLProfileManager.h | 2 +- 6 files changed, 28 insertions(+), 17 deletions(-) diff --git a/include/fastrtps/config/doxygen_modules.h b/include/fastrtps/config/doxygen_modules.h index 4aa8368b3b2..9df7c40aa50 100644 --- a/include/fastrtps/config/doxygen_modules.h +++ b/include/fastrtps/config/doxygen_modules.h @@ -80,6 +80,16 @@ * This module contains all classes and methods associated with RTPSReader and its specifications, as well as other necessary classes. */ +/** @defgroup TYPES_MODULE Contains the builtin generated types + * @namespace eprosima::fastrtps::types + * @ingroup FASTRTPS_MODULE + */ + +/** @defgroup XMLPARSER_MODULE Contains all the modules related with the XMLParser + * @namespace eprosima::fastrtps::xmlparser + * @ingroup FASTRTPS_MODULE + */ + #ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC /** @defgroup PARAMETER_MODULE Qos Module diff --git a/include/fastrtps/types/AnnotationParameterValue.h b/include/fastrtps/types/AnnotationParameterValue.h index b56f4479753..55ad4020512 100644 --- a/include/fastrtps/types/AnnotationParameterValue.h +++ b/include/fastrtps/types/AnnotationParameterValue.h @@ -58,7 +58,7 @@ namespace types { /*! * @brief This class represents the structure ExtendedAnnotationParameterValue defined by the user in the IDL file. - * @ingroup ANNOTATIONPARAMETERVALUE + * @ingroup TYPES_MODULE */ class ExtendedAnnotationParameterValue { @@ -108,6 +108,7 @@ class ExtendedAnnotationParameterValue * @param current_alignment Buffer alignment. * @return Serialized size. */ + RTPS_DllAPI static size_t getCdrSerializedSize( const ExtendedAnnotationParameterValue& data, size_t current_alignment = 0); @@ -160,7 +161,7 @@ class ExtendedAnnotationParameterValue }; /*! * @brief This class represents the union AnnotationParameterValue defined by the user in the IDL file. - * @ingroup ANNOTATIONPARAMETERVALUE + * @ingroup TYPES_MODULE */ class AnnotationParameterValue { @@ -813,7 +814,7 @@ class AnnotationParameterValue /*! * @brief This class represents the structure AppliedAnnotationParameter defined by the user in the IDL file. - * @ingroup ANNOTATIONPARAMETERVALUE + * @ingroup TYPES_MODULE */ class AppliedAnnotationParameter { diff --git a/include/fastrtps/types/TypeIdentifierTypes.h b/include/fastrtps/types/TypeIdentifierTypes.h index c4e8ffffbad..2f0335de15f 100644 --- a/include/fastrtps/types/TypeIdentifierTypes.h +++ b/include/fastrtps/types/TypeIdentifierTypes.h @@ -53,7 +53,7 @@ class StringLTypeDefn; /*! * @brief This class represents the structure StringSTypeDefn defined by the user in the IDL file. - * @ingroup TYPEIDENTIFIERTYPES + * @ingroup TYPES_MODULE */ class StringSTypeDefn final { @@ -164,7 +164,7 @@ class StringSTypeDefn final }; /*! * @brief This class represents the structure StringLTypeDefn defined by the user in the IDL file. - * @ingroup TYPEIDENTIFIERTYPES + * @ingroup TYPES_MODULE */ class StringLTypeDefn final { @@ -275,7 +275,7 @@ class StringLTypeDefn final }; /*! * @brief This class represents the structure PlainCollectionHeader defined by the user in the IDL file. - * @ingroup TYPEIDENTIFIERTYPES + * @ingroup TYPES_MODULE */ class PlainCollectionHeader final { @@ -410,7 +410,7 @@ class PlainCollectionHeader final }; /*! * @brief This class represents the structure PlainSequenceSElemDefn defined by the user in the IDL file. - * @ingroup TYPEIDENTIFIERTYPES + * @ingroup TYPES_MODULE */ class PlainSequenceSElemDefn final { @@ -580,7 +580,7 @@ class PlainSequenceSElemDefn final }; /*! * @brief This class represents the structure PlainSequenceLElemDefn defined by the user in the IDL file. - * @ingroup TYPEIDENTIFIERTYPES + * @ingroup TYPES_MODULE */ class PlainSequenceLElemDefn final { @@ -750,7 +750,7 @@ class PlainSequenceLElemDefn final }; /*! * @brief This class represents the structure PlainArraySElemDefn defined by the user in the IDL file. - * @ingroup TYPEIDENTIFIERTYPES + * @ingroup TYPES_MODULE */ class PlainArraySElemDefn final { @@ -930,7 +930,7 @@ class PlainArraySElemDefn final }; /*! * @brief This class represents the structure PlainArrayLElemDefn defined by the user in the IDL file. - * @ingroup TYPEIDENTIFIERTYPES + * @ingroup TYPES_MODULE */ class PlainArrayLElemDefn final { @@ -1110,7 +1110,7 @@ class PlainArrayLElemDefn final }; /*! * @brief This class represents the structure PlainMapSTypeDefn defined by the user in the IDL file. - * @ingroup TYPEIDENTIFIERTYPES + * @ingroup TYPES_MODULE */ class PlainMapSTypeDefn final { @@ -1333,7 +1333,7 @@ class PlainMapSTypeDefn final }; /*! * @brief This class represents the structure PlainMapLTypeDefn defined by the user in the IDL file. - * @ingroup TYPEIDENTIFIERTYPES + * @ingroup TYPES_MODULE */ class PlainMapLTypeDefn final { @@ -1556,7 +1556,7 @@ class PlainMapLTypeDefn final }; /*! * @brief This class represents the structure StronglyConnectedComponentId defined by the user in the IDL file. - * @ingroup TYPEIDENTIFIERTYPES + * @ingroup TYPES_MODULE */ class StronglyConnectedComponentId final { @@ -1729,7 +1729,7 @@ class StronglyConnectedComponentId final }; /*! * @brief This class represents the structure ExtendedTypeDefn defined by the user in the IDL file. - * @ingroup TYPEIDENTIFIERTYPES + * @ingroup TYPES_MODULE */ class ExtendedTypeDefn final { diff --git a/include/fastrtps/types/TypeObjectHashId.h b/include/fastrtps/types/TypeObjectHashId.h index dda63fb4d2f..d10efec46ea 100644 --- a/include/fastrtps/types/TypeObjectHashId.h +++ b/include/fastrtps/types/TypeObjectHashId.h @@ -48,7 +48,7 @@ typedef octet EquivalenceHash[14]; /*! * @brief This class represents the union TypeObjectHashId defined by the user in the IDL file. - * @ingroup TYPEOBJECTHASHID + * @ingroup TYPES_MODULE */ class TypeObjectHashId { diff --git a/include/fastrtps/xmlparser/XMLEndpointParser.h b/include/fastrtps/xmlparser/XMLEndpointParser.h index 0edd2f0c85c..64743af59b6 100644 --- a/include/fastrtps/xmlparser/XMLEndpointParser.h +++ b/include/fastrtps/xmlparser/XMLEndpointParser.h @@ -75,7 +75,7 @@ class StaticRTPSParticipantInfo /** * Class XMLEndpointParser used to parse the XML file that contains information about remote endpoints. - * @ingroup DISCVOERYMODULE + * @ingroup DISCOVERY_MODULE */ class XMLEndpointParser : XMLParser { diff --git a/include/fastrtps/xmlparser/XMLProfileManager.h b/include/fastrtps/xmlparser/XMLProfileManager.h index bb934e3b978..3797a493fce 100644 --- a/include/fastrtps/xmlparser/XMLProfileManager.h +++ b/include/fastrtps/xmlparser/XMLProfileManager.h @@ -49,7 +49,7 @@ using xmlfile_map_iterator_t = xmlfiles_map_t::iterator; /** * Class XMLProfileManager, used to make available profiles from XML file. - * @ingroup XMLPROFILEMANAGER_MODULE + * @ingroup XMLPARSER_MODULE */ class XMLProfileManager {