Issue #15 [doxygen] Fix doc grouping

This commit is contained in:
Mat Sutcliffe
2020-08-03 00:31:08 +01:00
parent b8a4ad9270
commit 01b861ca0d
18 changed files with 22 additions and 7 deletions

View File

@@ -30,11 +30,13 @@
/*! /*!
* \namespace BlackMisc::SharedState * \namespace BlackMisc::SharedState
* \brief Utilities for sharing state between multiple objects. * \brief Utilities for sharing state between multiple objects.
* \ingroup SharedState
*/ */
/*! /*!
* \namespace BlackMisc::SharedState::DBus * \namespace BlackMisc::SharedState::DBus
* \brief Implementation detail classes used by SharedState::CDataLinkDBus. * \brief Implementation detail classes used by SharedState::CDataLinkDBus.
* \ingroup SharedState
*/ */
/*! /*!

View File

@@ -24,6 +24,7 @@ namespace BlackMisc
{ {
/*! /*!
* Extends CPassiveMutator with the ability to respond to requests. * Extends CPassiveMutator with the ability to respond to requests.
* \ingroup SharedState
*/ */
class BLACKMISC_EXPORT CActiveMutator final : public CPassiveMutator class BLACKMISC_EXPORT CActiveMutator final : public CPassiveMutator
{ {

View File

@@ -24,6 +24,7 @@ namespace BlackMisc
{ {
/*! /*!
* Extends CPassiveObserver with the ability to send requests and receive replies. * Extends CPassiveObserver with the ability to send requests and receive replies.
* \ingroup SharedState
*/ */
class BLACKMISC_EXPORT CActiveObserver final : public CPassiveObserver class BLACKMISC_EXPORT CActiveObserver final : public CPassiveObserver
{ {

View File

@@ -20,7 +20,8 @@
#include <QStringBuilder> #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. * Observe the connection state of an IDataLink.
* \ingroup SharedState
*/ */
class CDataLinkConnectionWatcher : public QObject class CDataLinkConnectionWatcher : public QObject
{ {

View File

@@ -37,7 +37,6 @@ namespace BlackMisc
* Abstract interface for the spoke in a star topology. An implementation detail of CDataLinkDBus. * 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. * Signals send messages from server to client; slots send messages from client to server.
* \ingroup SharedState
*/ */
class BLACKMISC_EXPORT IDuplex : public QObject class BLACKMISC_EXPORT IDuplex : public QObject
{ {

View File

@@ -27,7 +27,6 @@ namespace BlackMisc
/*! /*!
* Server side implementation of IDuplex. Receives messages from clients and forwards them to other clients via the CHub. * 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 class BLACKMISC_EXPORT CDuplex : public IDuplex
{ {

View File

@@ -23,7 +23,6 @@ namespace BlackMisc
{ {
/*! /*!
* Client side implementation of IDuplex, through which the client communicates with the server. * Client side implementation of IDuplex, through which the client communicates with the server.
* \ingroup SharedState
*/ */
class BLACKMISC_EXPORT CDuplexProxy : public IDuplex class BLACKMISC_EXPORT CDuplexProxy : public IDuplex
{ {

View File

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

View File

@@ -28,7 +28,6 @@ namespace BlackMisc
/*! /*!
* Server side implementation of IHub. Maintains a collection of CDuplex objects. * Server side implementation of IHub. Maintains a collection of CDuplex objects.
* \ingroup SharedState
*/ */
class BLACKMISC_EXPORT CHub : public IHub class BLACKMISC_EXPORT CHub : public IHub
{ {

View File

@@ -24,7 +24,6 @@ namespace BlackMisc
{ {
/*! /*!
* Client side implementation of IHub. * Client side implementation of IHub.
* \ingroup SharedState
*/ */
class BLACKMISC_EXPORT CHubProxy : public IHub class BLACKMISC_EXPORT CHubProxy : public IHub
{ {

View File

@@ -26,6 +26,7 @@ namespace BlackMisc
/*! /*!
* Non-template base class for CListJournal. * Non-template base class for CListJournal.
* \ingroup SharedState
*/ */
class BLACKMISC_EXPORT CGenericListJournal : public QObject 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. * Base class for an object that shares state with a corresponding CListObserver subclass object.
* \tparam T Datatype encapsulating the state to be shared. * \tparam T Datatype encapsulating the state to be shared.
* \ingroup SharedState
*/ */
template <typename T> template <typename T>
class CListJournal : public CGenericListJournal class CListJournal : public CGenericListJournal

View File

@@ -25,6 +25,7 @@ namespace BlackMisc
/*! /*!
* Non-template base class for CListMutator. * Non-template base class for CListMutator.
* \ingroup SharedState
*/ */
class BLACKMISC_EXPORT CGenericListMutator : public QObject 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. * Base class for an object that shares state with a corresponding CListObserver subclass object.
* \tparam T Datatype encapsulating the state to be shared. * \tparam T Datatype encapsulating the state to be shared.
* \ingroup SharedState
*/ */
template <typename T> template <typename T>
class CListMutator : public CGenericListMutator class CListMutator : public CGenericListMutator

View File

@@ -24,6 +24,7 @@ namespace BlackMisc
{ {
/*! /*!
* Non-template base class for CListObserver. * Non-template base class for CListObserver.
* \ingroup SharedState
*/ */
class BLACKMISC_EXPORT CGenericListObserver : public QObject 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. * Base class for an object that shares state with a corresponding CListMutator subclass object.
* \tparam T Datatype encapsulating the state to be shared. * \tparam T Datatype encapsulating the state to be shared.
* \tparam U Datatype describing a filter to apply to the list. * \tparam U Datatype describing a filter to apply to the list.
* \ingroup SharedState
*/ */
template <typename T, typename U = CAnyMatch> template <typename T, typename U = CAnyMatch>
class CListObserver : public CGenericListObserver class CListObserver : public CGenericListObserver

View File

@@ -24,6 +24,7 @@ namespace BlackMisc
/*! /*!
* Endpoint which can emit events to subscribers. * Endpoint which can emit events to subscribers.
* \ingroup SharedState
*/ */
class BLACKMISC_EXPORT CPassiveMutator : public QObject, public QEnableSharedFromThis<CPassiveMutator> class BLACKMISC_EXPORT CPassiveMutator : public QObject, public QEnableSharedFromThis<CPassiveMutator>
{ {

View File

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

View File

@@ -26,6 +26,7 @@ namespace BlackMisc
/*! /*!
* Non-template base class for CScalarJournal. * Non-template base class for CScalarJournal.
* \ingroup SharedState
*/ */
class BLACKMISC_EXPORT CGenericScalarJournal : public QObject 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. * Base class for an object that shares state with a corresponding CScalarObserver subclass object.
* \tparam T Datatype encapsulating the state to be shared. * \tparam T Datatype encapsulating the state to be shared.
* \ingroup SharedState
*/ */
template <typename T> template <typename T>
class CScalarJournal : public CGenericScalarJournal class CScalarJournal : public CGenericScalarJournal

View File

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

View File

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