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) (#4393)

* Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 (#4376)

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

* Linter

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>

---------

Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com>
Co-authored-by: Mario Dominguez <mariodominguez@eprosima.com>
  • Loading branch information
3 people authored Feb 29, 2024
1 parent 464de2d commit a0b3633
Show file tree
Hide file tree
Showing 6 changed files with 103 additions and 62 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
6 changes: 3 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 @@ -160,7 +160,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 +813,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
Loading

0 comments on commit a0b3633

Please sign in to comment.