Remove doxygen directive @group in enumerations and typedefs (#5011)

This fixes a bug between doxygen >1.9.7 and breathe 4.35.0 Signed-off-by: Ricardo González Moreno <[email protected]>
eProsima · Jul 5, 2024 · f973dc5 · f973dc5
1 parent 9243ead
commit f973dc5
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 47 deletions.
diff --git a/include/fastdds/rtps/common/ChangeKind_t.hpp b/include/fastdds/rtps/common/ChangeKind_t.hpp
@@ -26,15 +26,14 @@ namespace fastdds {
 namespace rtps {
 
 /**
- * @enum ChangeKind_t, different types of CacheChange_t.
- * @ingroup COMMON_MODULE
+ * Enumerates the different types of CacheChange_t.
  */
 enum FASTDDS_EXPORTED_API ChangeKind_t
 {
-    ALIVE,                            //!< ALIVE
-    NOT_ALIVE_DISPOSED,               //!< NOT_ALIVE_DISPOSED
-    NOT_ALIVE_UNREGISTERED,           //!< NOT_ALIVE_UNREGISTERED
-    NOT_ALIVE_DISPOSED_UNREGISTERED   //!< NOT_ALIVE_DISPOSED_UNREGISTERED
+    ALIVE,                          //!< ALIVE
+    NOT_ALIVE_DISPOSED,             //!< NOT_ALIVE_DISPOSED
+    NOT_ALIVE_UNREGISTERED,         //!< NOT_ALIVE_UNREGISTERED
+    NOT_ALIVE_DISPOSED_UNREGISTERED //!< NOT_ALIVE_DISPOSED_UNREGISTERED
 };
 
 } // namespace rtps

diff --git a/include/fastdds/rtps/common/FragmentNumber.hpp b/include/fastdds/rtps/common/FragmentNumber.hpp
@@ -23,18 +23,17 @@
 #include <fastdds/rtps/common/Types.hpp>
 #include <fastdds/utils/fixed_size_bitmap.hpp>
 
-#include <set>
-#include <cmath>
 #include <algorithm>
+#include <cmath>
+#include <set>
 
 namespace eprosima {
 namespace fastdds {
 namespace rtps {
 
 using FragmentNumber_t = uint32_t;
 
-//!Structure FragmentNumberSet_t, contains a group of fragmentnumbers.
-//!@ingroup COMMON_MODULE
+//! Structure FragmentNumberSet_t, contains a group of fragmentnumbers.
 using FragmentNumberSet_t = BitmapRange<FragmentNumber_t>;
 
 inline std::ostream& operator <<(

diff --git a/include/fastdds/rtps/common/MatchingInfo.hpp b/include/fastdds/rtps/common/MatchingInfo.hpp
@@ -14,7 +14,6 @@
 
 /**
  * @file MatchingInfo.hpp
- *
  */
 
 #ifndef FASTDDS_RTPS_COMMON__MATCHINGINFO_HPP
@@ -27,20 +26,18 @@ namespace fastdds {
 namespace rtps {
 
 /**
- * @enum MatchingStatus, indicates whether the matched publication/subscription method of the PublisherListener or SubscriberListener has
+ * Indicates whether the matched publication/subscription method of the PublisherListener or SubscriberListener has
  * been called for a matching or a removal of a remote endpoint.
- * @ingroup COMMON_MODULE
  */
 #if defined(_WIN32)
 enum FASTDDS_EXPORTED_API MatchingStatus
 {
 #else
 enum MatchingStatus
 {
-#endif // if defined(_WIN32)
-    MATCHED_MATCHING,//!< MATCHED_MATCHING, new publisher/subscriber found
-    REMOVED_MATCHING //!< REMOVED_MATCHING, publisher/subscriber removed
-
+#endif                // if defined(_WIN32)
+    MATCHED_MATCHING, //!< MATCHED_MATCHING, new publisher/subscriber found
+    REMOVED_MATCHING  //!< REMOVED_MATCHING, publisher/subscriber removed
 };
 
 /**
@@ -51,7 +48,7 @@ class FASTDDS_EXPORTED_API MatchingInfo
 {
 public:
 
-    //!Default constructor
+    //! Default constructor
     MatchingInfo()
         : status(MATCHED_MATCHING)
     {
@@ -73,9 +70,9 @@ class FASTDDS_EXPORTED_API MatchingInfo
     {
     }
 
-    //!Status
+    //! Status
     MatchingStatus status;
-    //!Remote endpoint GUID
+    //! Remote endpoint GUID
     GUID_t remoteEndpointGuid;
 };
 } // namespace rtps

diff --git a/include/fastdds/rtps/common/SequenceNumber.hpp b/include/fastdds/rtps/common/SequenceNumber.hpp
@@ -32,7 +32,6 @@ namespace eprosima {
 namespace fastdds {
 namespace rtps {
 
-
 //!@brief Structure SequenceNumber_t, different for each change in the same writer.
 //!@ingroup COMMON_MODULE
 struct FASTDDS_EXPORTED_API SequenceNumber_t
@@ -42,7 +41,7 @@ struct FASTDDS_EXPORTED_API SequenceNumber_t
     //!
     uint32_t low = 0;
 
-    //!Default constructor
+    //! Default constructor
     SequenceNumber_t() noexcept
     {
         high = 0;
@@ -64,8 +63,7 @@ struct FASTDDS_EXPORTED_API SequenceNumber_t
     /*!
      * @param u
      */
-    explicit
-    SequenceNumber_t(
+    explicit SequenceNumber_t(
             uint64_t u) noexcept
         : high(static_cast<int32_t>(u >> 32u))
         , low(static_cast<uint32_t>(u))
@@ -110,7 +108,7 @@ struct FASTDDS_EXPORTED_API SequenceNumber_t
     {
         assert(inc >= 0);
         uint32_t aux_low = low;
-        low +=  static_cast<uint32_t>(inc);
+        low += static_cast<uint32_t>(inc);
 
         if (low < aux_low)
         {
@@ -124,7 +122,7 @@ struct FASTDDS_EXPORTED_API SequenceNumber_t
 
     static SequenceNumber_t unknown() noexcept
     {
-        return { -1, 0 };
+        return {-1, 0};
     }
 
 };
@@ -366,8 +364,7 @@ struct SequenceNumberDiff
 
 #endif // ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
 
-//!Structure SequenceNumberSet_t, contains a group of sequencenumbers.
-//!@ingroup COMMON_MODULE
+//! Structure SequenceNumberSet_t, contains a group of sequencenumbers.
 using SequenceNumberSet_t = BitmapRange<SequenceNumber_t, SequenceNumberDiff, 256>;
 
 #ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC

diff --git a/include/fastdds/rtps/common/Types.hpp b/include/fastdds/rtps/common/Types.hpp
@@ -19,9 +19,9 @@
 #ifndef FASTDDS_RTPS_COMMON__TYPES_HPP
 #define FASTDDS_RTPS_COMMON__TYPES_HPP
 
-#include <stddef.h>
-#include <iostream>
 #include <cstdint>
+#include <iostream>
+#include <stddef.h>
 #include <stdint.h>
 
 #include <fastdds/fastdds_dll.hpp>
@@ -34,7 +34,6 @@ namespace rtps {
 
 /*!
  * @brief This enumeration represents endianness types.
- * @ingroup COMMON_MODULE
  */
 enum Endianness_t
 {
@@ -44,38 +43,35 @@ enum Endianness_t
     LITTLEEND = 0x0
 };
 
-//!Reliability enum used for internal purposes
-//!@ingroup COMMON_MODULE
+//! Reliability enum used for internal purposes
 typedef enum ReliabilityKind_t
 {
     RELIABLE,
     BEST_EFFORT
-}ReliabilityKind_t;
+} ReliabilityKind_t;
 
-//!Durability kind
-//!@ingroup COMMON_MODULE
+//! Durability kind
 typedef enum DurabilityKind_t
 {
     VOLATILE,        //!< Volatile Durability
     TRANSIENT_LOCAL, //!< Transient Local Durability
     TRANSIENT,       //!< Transient Durability.
     PERSISTENT       //!< NOT IMPLEMENTED.
-}DurabilityKind_t;
+} DurabilityKind_t;
 
-//!Endpoint kind
-//!@ingroup COMMON_MODULE
+//! Endpoint kind
 typedef enum EndpointKind_t
 {
     READER,
     WRITER
-}EndpointKind_t;
+} EndpointKind_t;
 
-//!Topic kind
+//! Topic kind
 typedef enum TopicKind_t
 {
     NO_KEY,
     WITH_KEY
-}TopicKind_t;
+} TopicKind_t;
 
 #if FASTDDS_IS_BIG_ENDIAN_TARGET
 constexpr Endianness_t DEFAULT_ENDIAN = BIGEND;
@@ -84,8 +80,8 @@ constexpr Endianness_t DEFAULT_ENDIAN = LITTLEEND;
 #endif // if FASTDDS_IS_BIG_ENDIAN_TARGET
 
 using octet = unsigned char;
-//typedef unsigned int uint;
-//typedef unsigned short ushort;
+// typedef unsigned int uint;
+// typedef unsigned short ushort;
 using SubmessageFlag = unsigned char;
 using BuiltinEndpointSet_t = uint32_t;
 using NetworkConfigSet_t = uint32_t;
@@ -108,15 +104,15 @@ struct FASTDDS_EXPORTED_API ProtocolVersion_t
     octet m_major;
     octet m_minor;
 
-    ProtocolVersion_t():
+    ProtocolVersion_t()
+        :
 #if HAVE_SECURITY
         // As imposed by DDSSEC11-93
         ProtocolVersion_t(2, 3)
 #else
         ProtocolVersion_t(2, 2)
 #endif // if HAVE_SECURITY
     {
-
     }
 
     ProtocolVersion_t(
@@ -125,7 +121,6 @@ struct FASTDDS_EXPORTED_API ProtocolVersion_t
         : m_major(maj)
         , m_minor(min)
     {
-
     }
 
     bool operator ==(