Issue #15 [doxygen] Fix doc grouping

2026-04-05 17:35:34 +08:00 · 2020-08-03 00:31:08 +01:00
parent b8a4ad9270
commit 01b861ca0d
18 changed files with 22 additions and 7 deletions
--- a/src/blackmisc/blackmisc.h
+++ b/src/blackmisc/blackmisc.h
@@ -30,11 +30,13 @@
 /*!
 * \namespace BlackMisc::SharedState
 * \brief Utilities for sharing state between multiple objects.
+ * \ingroup SharedState
 */

 /*!
 * \namespace BlackMisc::SharedState::DBus
 * \brief Implementation detail classes used by SharedState::CDataLinkDBus.
+ * \ingroup SharedState
 */

 /*!
--- a/src/blackmisc/sharedstate/activemutator.h
+++ b/src/blackmisc/sharedstate/activemutator.h
@@ -24,6 +24,7 @@ namespace BlackMisc
    {
        /*!
         * Extends CPassiveMutator with the ability to respond to requests.
+         * \ingroup SharedState
         */
        class BLACKMISC_EXPORT CActiveMutator final : public CPassiveMutator
        {
--- a/src/blackmisc/sharedstate/activeobserver.h
+++ b/src/blackmisc/sharedstate/activeobserver.h
@@ -24,6 +24,7 @@ namespace BlackMisc
    {
        /*!
         * Extends CPassiveObserver with the ability to send requests and receive replies.
+         * \ingroup SharedState
         */
        class BLACKMISC_EXPORT CActiveObserver final : public CPassiveObserver
        {
--- a/src/blackmisc/sharedstate/datalink.h
+++ b/src/blackmisc/sharedstate/datalink.h
@@ -20,7 +20,8 @@
 #include <QStringBuilder>

 /*!
- * \defgroup SharedState Utilities for sharing state between multiple objects
+ * \defgroup SharedState Shared state
+ * Utilities for sharing state between multiple objects
 */

 /*!
@@ -41,6 +42,7 @@ namespace BlackMisc

        /*!
         * Observe the connection state of an IDataLink.
+         * \ingroup SharedState
         */
        class CDataLinkConnectionWatcher : public QObject
        {
--- a/src/blackmisc/sharedstate/dbus/duplex.h
+++ b/src/blackmisc/sharedstate/dbus/duplex.h
@@ -37,7 +37,6 @@ namespace BlackMisc
             * Abstract interface for the spoke in a star topology. An implementation detail of CDataLinkDBus.
             *
             * Signals send messages from server to client; slots send messages from client to server.
-             * \ingroup SharedState
             */
            class BLACKMISC_EXPORT IDuplex : public QObject
            {
--- a/src/blackmisc/sharedstate/dbus/dupleximpl.h
+++ b/src/blackmisc/sharedstate/dbus/dupleximpl.h
@@ -27,7 +27,6 @@ namespace BlackMisc

            /*!
             * Server side implementation of IDuplex. Receives messages from clients and forwards them to other clients via the CHub.
-             * \ingroup SharedState
             */
            class BLACKMISC_EXPORT CDuplex : public IDuplex
            {
--- a/src/blackmisc/sharedstate/dbus/duplexproxy.h
+++ b/src/blackmisc/sharedstate/dbus/duplexproxy.h
@@ -23,7 +23,6 @@ namespace BlackMisc
        {
            /*!
             * Client side implementation of IDuplex, through which the client communicates with the server.
-             * \ingroup SharedState
             */
            class BLACKMISC_EXPORT CDuplexProxy : public IDuplex
            {
--- a/src/blackmisc/sharedstate/dbus/hub.h
+++ b/src/blackmisc/sharedstate/dbus/hub.h
@@ -38,7 +38,6 @@ namespace BlackMisc

            /*!
             * Abstract interface for the hub in a star topology. An implementation detail of CDataLinkDBus.
-             * \ingroup SharedState
             */
            class BLACKMISC_EXPORT IHub : public QObject
            {
--- a/src/blackmisc/sharedstate/dbus/hubimpl.h
+++ b/src/blackmisc/sharedstate/dbus/hubimpl.h
@@ -28,7 +28,6 @@ namespace BlackMisc

            /*!
             * Server side implementation of IHub. Maintains a collection of CDuplex objects.
-             * \ingroup SharedState
             */
            class BLACKMISC_EXPORT CHub : public IHub
            {
--- a/src/blackmisc/sharedstate/dbus/hubproxy.h
+++ b/src/blackmisc/sharedstate/dbus/hubproxy.h
@@ -24,7 +24,6 @@ namespace BlackMisc
        {
            /*!
             * Client side implementation of IHub.
-             * \ingroup SharedState
             */
            class BLACKMISC_EXPORT CHubProxy : public IHub
            {
--- a/src/blackmisc/sharedstate/listjournal.h
+++ b/src/blackmisc/sharedstate/listjournal.h
@@ -26,6 +26,7 @@ namespace BlackMisc

        /*!
         * Non-template base class for CListJournal.
+         * \ingroup SharedState
         */
        class BLACKMISC_EXPORT CGenericListJournal : public QObject
        {
@@ -51,6 +52,7 @@ namespace BlackMisc
        /*!
         * Base class for an object that shares state with a corresponding CListObserver subclass object.
         * \tparam T Datatype encapsulating the state to be shared.
+         * \ingroup SharedState
         */
        template <typename T>
        class CListJournal : public CGenericListJournal
--- a/src/blackmisc/sharedstate/listmutator.h
+++ b/src/blackmisc/sharedstate/listmutator.h
@@ -25,6 +25,7 @@ namespace BlackMisc

        /*!
         * Non-template base class for CListMutator.
+         * \ingroup SharedState
         */
        class BLACKMISC_EXPORT CGenericListMutator : public QObject
        {
@@ -48,6 +49,7 @@ namespace BlackMisc
        /*!
         * Base class for an object that shares state with a corresponding CListObserver subclass object.
         * \tparam T Datatype encapsulating the state to be shared.
+         * \ingroup SharedState
         */
        template <typename T>
        class CListMutator : public CGenericListMutator
--- a/src/blackmisc/sharedstate/listobserver.h
+++ b/src/blackmisc/sharedstate/listobserver.h
@@ -24,6 +24,7 @@ namespace BlackMisc
    {
        /*!
         * Non-template base class for CListObserver.
+         * \ingroup SharedState
         */
        class BLACKMISC_EXPORT CGenericListObserver : public QObject
        {
@@ -61,6 +62,7 @@ namespace BlackMisc
         * Base class for an object that shares state with a corresponding CListMutator subclass object.
         * \tparam T Datatype encapsulating the state to be shared.
         * \tparam U Datatype describing a filter to apply to the list.
+         * \ingroup SharedState
         */
        template <typename T, typename U = CAnyMatch>
        class CListObserver : public CGenericListObserver
--- a/src/blackmisc/sharedstate/passivemutator.h
+++ b/src/blackmisc/sharedstate/passivemutator.h
@@ -24,6 +24,7 @@ namespace BlackMisc

        /*!
         * Endpoint which can emit events to subscribers.
+         * \ingroup SharedState
         */
        class BLACKMISC_EXPORT CPassiveMutator : public QObject, public QEnableSharedFromThis<CPassiveMutator>
        {
--- a/src/blackmisc/sharedstate/passiveobserver.h
+++ b/src/blackmisc/sharedstate/passiveobserver.h
@@ -26,6 +26,7 @@ namespace BlackMisc

        /*!
         * Endpoint which can subscribe to events emitted by CPassiveMutator.
+         * \ingroup SharedState
         */
        class BLACKMISC_EXPORT CPassiveObserver : public QObject, public QEnableSharedFromThis<CPassiveObserver>
        {
@@ -69,6 +70,7 @@ namespace BlackMisc

        /*!
         * Dummy value class that matches any event.
+         * \ingroup SharedState
         */
        class BLACKMISC_EXPORT CAnyMatch : public CValueObject<CAnyMatch>
        {
--- a/src/blackmisc/sharedstate/scalarjournal.h
+++ b/src/blackmisc/sharedstate/scalarjournal.h
@@ -26,6 +26,7 @@ namespace BlackMisc

        /*!
         * Non-template base class for CScalarJournal.
+         * \ingroup SharedState
         */
        class BLACKMISC_EXPORT CGenericScalarJournal : public QObject
        {
@@ -51,6 +52,7 @@ namespace BlackMisc
        /*!
         * Base class for an object that shares state with a corresponding CScalarObserver subclass object.
         * \tparam T Datatype encapsulating the state to be shared.
+         * \ingroup SharedState
         */
        template <typename T>
        class CScalarJournal : public CGenericScalarJournal
--- a/src/blackmisc/sharedstate/scalarmutator.h
+++ b/src/blackmisc/sharedstate/scalarmutator.h
@@ -25,6 +25,7 @@ namespace BlackMisc

        /*!
         * Non-template base class for CScalarMutator.
+         * \ingroup SharedState
         */
        class BLACKMISC_EXPORT CGenericScalarMutator : public QObject
        {
@@ -48,6 +49,7 @@ namespace BlackMisc
        /*!
         * Base class for an object that shares state with a corresponding CScalarObserver subclass object.
         * \tparam T Datatype encapsulating the state to be shared.
+         * \ingroup SharedState
         */
        template <typename T>
        class CScalarMutator : public CGenericScalarMutator
--- a/src/blackmisc/sharedstate/scalarobserver.h
+++ b/src/blackmisc/sharedstate/scalarobserver.h
@@ -25,6 +25,7 @@ namespace BlackMisc

        /*!
         * Non-template base class for CScalarObserver.
+         * \ingroup SharedState
         */
        class BLACKMISC_EXPORT CGenericScalarObserver : public QObject
        {
@@ -54,6 +55,7 @@ namespace BlackMisc
        /*!
         * Base class for an object that shares state with a corresponding CScalarMutator subclass object.
         * \tparam T Datatype encapsulating the state to be shared.
+         * \ingroup SharedState
         */
        template <typename T>
        class CScalarObserver : public CGenericScalarObserver