Skip to content

Commit

Permalink
Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 (#…
Browse files Browse the repository at this point in the history
…4376) (#4392)

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com>
  • Loading branch information
2 people authored and cferreiragonz committed Mar 11, 2024
1 parent ef76d28 commit f49c0db
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 17 deletions.
10 changes: 10 additions & 0 deletions include/fastrtps/config/doxygen_modules.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 4 additions & 3 deletions include/fastrtps/types/AnnotationParameterValue.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down
22 changes: 11 additions & 11 deletions include/fastrtps/types/TypeIdentifierTypes.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion include/fastrtps/types/TypeObjectHashId.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion include/fastrtps/xmlparser/XMLEndpointParser.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion include/fastrtps/xmlparser/XMLProfileManager.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down

0 comments on commit f49c0db

Please sign in to comment.