Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[20413] Fix doxygen docs warnings. Prepare for compiling with Doxygen 1.10.0 (backport #4376) #4393

Merged
merged 2 commits into from
Feb 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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