From: Bartosz Golaszewski <bartosz.golaszewski@xxxxxxxxxx> Groups make sense for the C API as they allow us to nicely order interfaces manipulating a given structure thematically but for C++ they make less sense as methods are already typically part of a class. Additionally for global functions, they seem to make it difficult for breathe to look up the correct symbols. Remove the gpiod_cxx group from Doxygen comments. Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@xxxxxxxxxx> --- bindings/cxx/gpiod.hpp | 6 ------ bindings/cxx/gpiodcxx/chip-info.hpp | 9 --------- bindings/cxx/gpiodcxx/chip.hpp | 9 --------- bindings/cxx/gpiodcxx/edge-event-buffer.hpp | 9 --------- bindings/cxx/gpiodcxx/edge-event.hpp | 9 --------- bindings/cxx/gpiodcxx/exception.hpp | 9 --------- bindings/cxx/gpiodcxx/info-event.hpp | 9 --------- bindings/cxx/gpiodcxx/line-config.hpp | 9 --------- bindings/cxx/gpiodcxx/line-info.hpp | 9 --------- bindings/cxx/gpiodcxx/line-request.hpp | 9 --------- bindings/cxx/gpiodcxx/line-settings.hpp | 9 --------- bindings/cxx/gpiodcxx/line.hpp | 9 --------- bindings/cxx/gpiodcxx/misc.hpp | 9 --------- bindings/cxx/gpiodcxx/request-builder.hpp | 9 --------- bindings/cxx/gpiodcxx/request-config.hpp | 9 --------- bindings/cxx/gpiodcxx/timestamp.hpp | 9 --------- 16 files changed, 141 deletions(-) diff --git a/bindings/cxx/gpiod.hpp b/bindings/cxx/gpiod.hpp index 91e41a5..606994d 100644 --- a/bindings/cxx/gpiod.hpp +++ b/bindings/cxx/gpiod.hpp @@ -8,12 +8,6 @@ #ifndef __LIBGPIOD_GPIOD_CXX_HPP__ #define __LIBGPIOD_GPIOD_CXX_HPP__ -/** - * @defgroup gpiod_cxx C++ bindings - * - * C++ bindings for libgpiod. - */ - /** * @cond */ diff --git a/bindings/cxx/gpiodcxx/chip-info.hpp b/bindings/cxx/gpiodcxx/chip-info.hpp index e740e94..61c0b78 100644 --- a/bindings/cxx/gpiodcxx/chip-info.hpp +++ b/bindings/cxx/gpiodcxx/chip-info.hpp @@ -19,11 +19,6 @@ namespace gpiod { class chip; -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Represents an immutable snapshot of GPIO chip information. */ @@ -96,10 +91,6 @@ private: */ ::std::ostream& operator<<(::std::ostream& out, const chip_info& chip); -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_CHIP_INFO_HPP__ */ diff --git a/bindings/cxx/gpiodcxx/chip.hpp b/bindings/cxx/gpiodcxx/chip.hpp index 4d67476..8a1389e 100644 --- a/bindings/cxx/gpiodcxx/chip.hpp +++ b/bindings/cxx/gpiodcxx/chip.hpp @@ -30,11 +30,6 @@ class line_request; class request_builder; class request_config; -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Represents a GPIO chip. */ @@ -173,10 +168,6 @@ private: */ ::std::ostream& operator<<(::std::ostream& out, const chip& chip); -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_CHIP_HPP__ */ diff --git a/bindings/cxx/gpiodcxx/edge-event-buffer.hpp b/bindings/cxx/gpiodcxx/edge-event-buffer.hpp index 2482e8a..083c2e1 100644 --- a/bindings/cxx/gpiodcxx/edge-event-buffer.hpp +++ b/bindings/cxx/gpiodcxx/edge-event-buffer.hpp @@ -22,11 +22,6 @@ namespace gpiod { class edge_event; class line_request; -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Object into which edge events are read for better performance. * @@ -120,10 +115,6 @@ private: */ ::std::ostream& operator<<(::std::ostream& out, const edge_event_buffer& buf); -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_EDGE_EVENT_BUFFER_HPP__ */ diff --git a/bindings/cxx/gpiodcxx/edge-event.hpp b/bindings/cxx/gpiodcxx/edge-event.hpp index 47c256a..acbe7af 100644 --- a/bindings/cxx/gpiodcxx/edge-event.hpp +++ b/bindings/cxx/gpiodcxx/edge-event.hpp @@ -22,11 +22,6 @@ namespace gpiod { class edge_event_buffer; -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Immutable object containing data about a single edge event. */ @@ -128,10 +123,6 @@ private: */ ::std::ostream& operator<<(::std::ostream& out, const edge_event& event); -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_EDGE_EVENT_HPP__ */ diff --git a/bindings/cxx/gpiodcxx/exception.hpp b/bindings/cxx/gpiodcxx/exception.hpp index 34737d2..b753af0 100644 --- a/bindings/cxx/gpiodcxx/exception.hpp +++ b/bindings/cxx/gpiodcxx/exception.hpp @@ -17,11 +17,6 @@ namespace gpiod { -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Exception thrown when an already closed chip is used. */ @@ -149,10 +144,6 @@ public: ~bad_mapping(); }; -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_EXCEPTION_HPP__ */ diff --git a/bindings/cxx/gpiodcxx/info-event.hpp b/bindings/cxx/gpiodcxx/info-event.hpp index 69b88b6..ee01651 100644 --- a/bindings/cxx/gpiodcxx/info-event.hpp +++ b/bindings/cxx/gpiodcxx/info-event.hpp @@ -23,11 +23,6 @@ namespace gpiod { class chip; class line_info; -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Immutable object containing data about a single line info event. */ @@ -114,10 +109,6 @@ private: */ ::std::ostream& operator<<(::std::ostream& out, const info_event& event); -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_INFO_EVENT_HPP__ */ diff --git a/bindings/cxx/gpiodcxx/line-config.hpp b/bindings/cxx/gpiodcxx/line-config.hpp index 58c9d87..b3b9aba 100644 --- a/bindings/cxx/gpiodcxx/line-config.hpp +++ b/bindings/cxx/gpiodcxx/line-config.hpp @@ -21,11 +21,6 @@ class chip; class line_request; class line_settings; -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Contains a set of line config options used in line requests and * reconfiguration. @@ -111,10 +106,6 @@ private: */ ::std::ostream& operator<<(::std::ostream& out, const line_config& config); -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_LINE_CONFIG_HPP__ */ diff --git a/bindings/cxx/gpiodcxx/line-info.hpp b/bindings/cxx/gpiodcxx/line-info.hpp index 8b10dc4..bf02ba1 100644 --- a/bindings/cxx/gpiodcxx/line-info.hpp +++ b/bindings/cxx/gpiodcxx/line-info.hpp @@ -22,11 +22,6 @@ namespace gpiod { class chip; class info_event; -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Contains an immutable snapshot of the line's state at the * time when the object of this class was instantiated. @@ -167,10 +162,6 @@ private: */ ::std::ostream& operator<<(::std::ostream& out, const line_info& info); -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_LINE_INFO_HPP__ */ diff --git a/bindings/cxx/gpiodcxx/line-request.hpp b/bindings/cxx/gpiodcxx/line-request.hpp index fcc4e0e..9605019 100644 --- a/bindings/cxx/gpiodcxx/line-request.hpp +++ b/bindings/cxx/gpiodcxx/line-request.hpp @@ -26,11 +26,6 @@ class edge_event; class edge_event_buffer; class line_config; -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Stores the context of a set of requested GPIO lines. */ @@ -227,10 +222,6 @@ private: */ ::std::ostream& operator<<(::std::ostream& out, const line_request& request); -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_LINE_REQUEST_HPP__ */ diff --git a/bindings/cxx/gpiodcxx/line-settings.hpp b/bindings/cxx/gpiodcxx/line-settings.hpp index 1004ccd..89d79f8 100644 --- a/bindings/cxx/gpiodcxx/line-settings.hpp +++ b/bindings/cxx/gpiodcxx/line-settings.hpp @@ -21,11 +21,6 @@ namespace gpiod { class line_config; -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Stores GPIO line settings. */ @@ -193,10 +188,6 @@ private: */ ::std::ostream& operator<<(::std::ostream& out, const line_settings& settings); -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_LINE_SETTINGS_HPP__ */ diff --git a/bindings/cxx/gpiodcxx/line.hpp b/bindings/cxx/gpiodcxx/line.hpp index 2810571..c58bf11 100644 --- a/bindings/cxx/gpiodcxx/line.hpp +++ b/bindings/cxx/gpiodcxx/line.hpp @@ -23,11 +23,6 @@ namespace gpiod { */ namespace line { -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Wrapper around unsigned int for representing line offsets. */ @@ -265,10 +260,6 @@ using value_mappings = ::std::vector<value_mapping>; */ ::std::ostream& operator<<(::std::ostream& out, const value_mappings& mappings); -/** - * @} - */ - } /* namespace line */ } /* namespace gpiod */ diff --git a/bindings/cxx/gpiodcxx/misc.hpp b/bindings/cxx/gpiodcxx/misc.hpp index eab8eba..cb56b92 100644 --- a/bindings/cxx/gpiodcxx/misc.hpp +++ b/bindings/cxx/gpiodcxx/misc.hpp @@ -16,11 +16,6 @@ namespace gpiod { -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Check if the file pointed to by path is a GPIO chip character device. * @param path Path to check. @@ -35,10 +30,6 @@ bool is_gpiochip_device(const ::std::filesystem::path& path); */ const ::std::string& api_version(); -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_MISC_HPP__ */ diff --git a/bindings/cxx/gpiodcxx/request-builder.hpp b/bindings/cxx/gpiodcxx/request-builder.hpp index 192bd91..62597b4 100644 --- a/bindings/cxx/gpiodcxx/request-builder.hpp +++ b/bindings/cxx/gpiodcxx/request-builder.hpp @@ -22,11 +22,6 @@ class line_config; class line_request; class request_config; -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Intermediate object storing the configuration for a line request. */ @@ -148,10 +143,6 @@ private: */ ::std::ostream& operator<<(::std::ostream& out, const request_builder& builder); -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_REQUEST_BUILDER_HPP__ */ diff --git a/bindings/cxx/gpiodcxx/request-config.hpp b/bindings/cxx/gpiodcxx/request-config.hpp index 6ebbf99..96f0262 100644 --- a/bindings/cxx/gpiodcxx/request-config.hpp +++ b/bindings/cxx/gpiodcxx/request-config.hpp @@ -23,11 +23,6 @@ namespace gpiod { class chip; -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Stores a set of options passed to the kernel when making a line * request. @@ -105,10 +100,6 @@ private: */ ::std::ostream& operator<<(::std::ostream& out, const request_config& config); -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_REQUEST_CONFIG_HPP__ */ diff --git a/bindings/cxx/gpiodcxx/timestamp.hpp b/bindings/cxx/gpiodcxx/timestamp.hpp index fcb4d8d..dc44eb7 100644 --- a/bindings/cxx/gpiodcxx/timestamp.hpp +++ b/bindings/cxx/gpiodcxx/timestamp.hpp @@ -17,11 +17,6 @@ namespace gpiod { -/** - * @ingroup gpiod_cxx - * @{ - */ - /** * @brief Stores the edge and info event timestamps as returned by the kernel * and allows to convert them to std::chrono::time_point. @@ -114,10 +109,6 @@ private: ::std::uint64_t _m_ns; }; -/** - * @} - */ - } /* namespace gpiod */ #endif /* __LIBGPIOD_CXX_TIMESTAMP_HPP__ */ -- 2.45.2