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)

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
  • Loading branch information
Mario-DL authored Feb 16, 2024
1 parent 05338cb commit dcf1c62
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 19 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
12 changes: 7 additions & 5 deletions include/fastrtps/types/AnnotationParameterValue.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,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 @@ -110,7 +110,8 @@ class ExtendedAnnotationParameterValue
* @param current_alignment Buffer alignment.
* @return Serialized size.
*/
FASTDDS_SER_METHOD_DEPRECATED(3, "eprosima::fastrtps::types::ExtendedAnnotationParameterValue::getCdrSerializedSize()",
FASTDDS_SER_METHOD_DEPRECATED(3,
"eprosima::fastrtps::types::ExtendedAnnotationParameterValue::getCdrSerializedSize()",
"In favor of version using eprosima::fastcdr::calculate_serialized_size.")
RTPS_DllAPI static size_t getCdrSerializedSize(
const ExtendedAnnotationParameterValue& data,
Expand Down Expand Up @@ -166,7 +167,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 @@ -824,7 +825,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 Expand Up @@ -1393,7 +1394,8 @@ class AppliedBuiltinMemberAnnotations
}

#ifndef DOXYGEN_SHOULD_SKIP_THIS
FASTDDS_SER_METHOD_DEPRECATED(3, "eprosima::fastrtps::types::AppliedBuiltinMemberAnnotations::getCdrSerializedSize()",
FASTDDS_SER_METHOD_DEPRECATED(3,
"eprosima::fastrtps::types::AppliedBuiltinMemberAnnotations::getCdrSerializedSize()",
"In favor of version using eprosima::fastcdr::calculate_serialized_size.")
RTPS_DllAPI static size_t getCdrSerializedSize(
const AppliedBuiltinMemberAnnotations& data,
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 @@ -54,7 +54,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 @@ -173,7 +173,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 @@ -292,7 +292,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 @@ -436,7 +436,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 @@ -616,7 +616,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 @@ -796,7 +796,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 @@ -986,7 +986,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 @@ -1176,7 +1176,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 @@ -1411,7 +1411,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 @@ -1646,7 +1646,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 @@ -1829,7 +1829,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 @@ -46,7 +46,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 @@ -52,7 +52,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 dcf1c62

Please sign in to comment.