From f973dc5dd21676c0cbd359154106aff7f8ee351a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ricardo=20Gonz=C3=A1lez?= Date: Fri, 5 Jul 2024 07:54:28 +0200 Subject: [PATCH] Remove doxygen directive @group in enumerations and typedefs (#5011) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This fixes a bug between doxygen >1.9.7 and breathe 4.35.0 Signed-off-by: Ricardo González Moreno --- include/fastdds/rtps/common/ChangeKind_t.hpp | 11 +++---- .../fastdds/rtps/common/FragmentNumber.hpp | 7 ++-- include/fastdds/rtps/common/MatchingInfo.hpp | 17 ++++------ .../fastdds/rtps/common/SequenceNumber.hpp | 13 +++----- include/fastdds/rtps/common/Types.hpp | 33 ++++++++----------- 5 files changed, 34 insertions(+), 47 deletions(-) diff --git a/include/fastdds/rtps/common/ChangeKind_t.hpp b/include/fastdds/rtps/common/ChangeKind_t.hpp index c46919613a4..5ac61a552f4 100644 --- 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 index 13066cf9e15..676649803f7 100644 --- a/include/fastdds/rtps/common/FragmentNumber.hpp +++ b/include/fastdds/rtps/common/FragmentNumber.hpp @@ -23,9 +23,9 @@ #include #include -#include -#include #include +#include +#include namespace eprosima { namespace fastdds { @@ -33,8 +33,7 @@ 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; inline std::ostream& operator <<( diff --git a/include/fastdds/rtps/common/MatchingInfo.hpp b/include/fastdds/rtps/common/MatchingInfo.hpp index 0fe91666ea5..f1e34f52241 100644 --- 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,9 +26,8 @@ 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 @@ -37,10 +35,9 @@ 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 index 734d8f27713..acdc12aa7bd 100644 --- 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(u >> 32u)) , low(static_cast(u)) @@ -110,7 +108,7 @@ struct FASTDDS_EXPORTED_API SequenceNumber_t { assert(inc >= 0); uint32_t aux_low = low; - low += static_cast(inc); + low += static_cast(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; #ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC diff --git a/include/fastdds/rtps/common/Types.hpp b/include/fastdds/rtps/common/Types.hpp index fc4c515b4c4..2e1105a0837 100644 --- 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 -#include #include +#include +#include #include #include @@ -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,7 +104,8 @@ 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) @@ -116,7 +113,6 @@ struct FASTDDS_EXPORTED_API ProtocolVersion_t 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 ==(