diff --git a/src/blackmisc/blackmisc.h b/src/blackmisc/blackmisc.h index 444b2b1d4..64cc4420c 100644 --- 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 */ /*! diff --git a/src/blackmisc/sharedstate/activemutator.h b/src/blackmisc/sharedstate/activemutator.h index b6aeb10d4..99e402a6a 100644 --- 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 { diff --git a/src/blackmisc/sharedstate/activeobserver.h b/src/blackmisc/sharedstate/activeobserver.h index abc7df3ca..81f99c8ac 100644 --- 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 { diff --git a/src/blackmisc/sharedstate/datalink.h b/src/blackmisc/sharedstate/datalink.h index 56de85f32..4a305d545 100644 --- a/src/blackmisc/sharedstate/datalink.h +++ b/src/blackmisc/sharedstate/datalink.h @@ -20,7 +20,8 @@ #include /*! - * \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 { diff --git a/src/blackmisc/sharedstate/dbus/duplex.h b/src/blackmisc/sharedstate/dbus/duplex.h index 01d031d16..74a5cd21e 100644 --- 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 { diff --git a/src/blackmisc/sharedstate/dbus/dupleximpl.h b/src/blackmisc/sharedstate/dbus/dupleximpl.h index 18462d189..4a8c41baa 100644 --- 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 { diff --git a/src/blackmisc/sharedstate/dbus/duplexproxy.h b/src/blackmisc/sharedstate/dbus/duplexproxy.h index abb13fe90..6e0573a2a 100644 --- 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 { diff --git a/src/blackmisc/sharedstate/dbus/hub.h b/src/blackmisc/sharedstate/dbus/hub.h index 12dde6eaa..9860e1edb 100644 --- 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 { diff --git a/src/blackmisc/sharedstate/dbus/hubimpl.h b/src/blackmisc/sharedstate/dbus/hubimpl.h index f599286e5..41586169d 100644 --- 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 { diff --git a/src/blackmisc/sharedstate/dbus/hubproxy.h b/src/blackmisc/sharedstate/dbus/hubproxy.h index 717476182..423954690 100644 --- 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 { diff --git a/src/blackmisc/sharedstate/listjournal.h b/src/blackmisc/sharedstate/listjournal.h index 8f5cb29d4..5aea8c12c 100644 --- 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 class CListJournal : public CGenericListJournal diff --git a/src/blackmisc/sharedstate/listmutator.h b/src/blackmisc/sharedstate/listmutator.h index af20d8506..969be475f 100644 --- 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 class CListMutator : public CGenericListMutator diff --git a/src/blackmisc/sharedstate/listobserver.h b/src/blackmisc/sharedstate/listobserver.h index 59f42f2fe..1b0aeb693 100644 --- 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 class CListObserver : public CGenericListObserver diff --git a/src/blackmisc/sharedstate/passivemutator.h b/src/blackmisc/sharedstate/passivemutator.h index f3af23bc3..0ae1eabc7 100644 --- 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 { diff --git a/src/blackmisc/sharedstate/passiveobserver.h b/src/blackmisc/sharedstate/passiveobserver.h index f81691c3e..f37d05571 100644 --- 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 { @@ -69,6 +70,7 @@ namespace BlackMisc /*! * Dummy value class that matches any event. + * \ingroup SharedState */ class BLACKMISC_EXPORT CAnyMatch : public CValueObject { diff --git a/src/blackmisc/sharedstate/scalarjournal.h b/src/blackmisc/sharedstate/scalarjournal.h index 0789fcbea..81d60d0ac 100644 --- 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 class CScalarJournal : public CGenericScalarJournal diff --git a/src/blackmisc/sharedstate/scalarmutator.h b/src/blackmisc/sharedstate/scalarmutator.h index af9b9f57c..b1fda4d58 100644 --- 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 class CScalarMutator : public CGenericScalarMutator diff --git a/src/blackmisc/sharedstate/scalarobserver.h b/src/blackmisc/sharedstate/scalarobserver.h index 42a92f76a..b5c3ca677 100644 --- 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 class CScalarObserver : public CGenericScalarObserver