refs #413 Doxygen.

src/blackmisc/blackmiscfreefunctions.h

@@ -118,6 +118,8 @@ namespace BlackMisc
 
         /*!
          * CRTP class template from which a derived class can inherit common methods dealing with hashing instances by metatuple.
+         *
+         * \tparam Derived Must be registered with BLACK_DECLARE_TUPLE_CONVERSION.
          */
         template <class Derived>
         class HashByTuple : private Private::EncapsulationBreaker
@@ -141,6 +143,10 @@ namespace BlackMisc
 
         /*!
          * CRTP class template from which a derived class can inherit string streaming operations.
+         *
+         * \tparam Derived Must implement a public method QString convertToQString(bool i18n = false) const.
+         *
+         * \see BLACKMISC_DECLARE_USING_MIXIN_STRING
          */
         template <class Derived>
         class String

src/blackmisc/compare.h

@@ -22,6 +22,8 @@ namespace BlackMisc
 
         /*!
          * CRTP class template from which a derived class can inherit operator== implemented using its compare function.
+         *
+         * \tparam Derived Must overload a function bool compare(const Derived &, const Derived &) which can be found by ADL.
          */
         template <class Derived>
         class EqualsByCompare
@@ -58,6 +60,8 @@ namespace BlackMisc
 
         /*!
          * CRTP class template from which a derived class can inherit operator< implemented using its compare function.
+         *
+         * \tparam Derived Must overload a function bool compare(const Derived &, const Derived &) which can be found by ADL.
          */
         template <class Derived>
         class LessThanByCompare
@@ -107,6 +111,8 @@ namespace BlackMisc
 
         /*!
          * CRTP class template from which a derived class can inherit non-member compare() implemented by metatuple.
+         *
+         * \tparam Derived Must be registered with BLACK_DECLARE_TUPLE_CONVERSION.
          */
         template <class Derived>
         class CompareByTuple : private Private::EncapsulationBreaker

src/blackmisc/dbus.h

@@ -24,6 +24,8 @@ namespace BlackMisc
 
         /*!
          * CRTP class template which will generate marshalling operators for a derived class with its own marshalling implementation.
+         *
+         * \tparam Derived Must implement public methods void marshallToDbus(QDBusArgument &arg) const and void unmarshallFromDbus(const QDBusArgument &arg).
          */
         template <class Derived>
         class DBusOperators
@@ -50,6 +52,10 @@ namespace BlackMisc
 
         /*!
          * CRTP class template from which a derived class can inherit common methods dealing with marshalling instances by metatuple.
+         *
+         * \tparam Derived Must be registered with BLACK_DECLARE_TUPLE_CONVERSION.
+         *
+         * \see BLACKMISC_DECLARE_USING_MIXIN_DBUS
          */
         template <class Derived>
         class DBusByTuple : public DBusOperators<Derived>, private Private::EncapsulationBreaker

src/blackmisc/json.h

@@ -136,6 +136,8 @@ namespace BlackMisc
 
         /*!
          * CRTP class template which will generate marshalling operators for a derived class with its own marshalling implementation.
+         *
+         * \tparam Must implement public methods QJsonObject toJson() const and void convertFromJson(const QJsonObject &json).
          */
         template <class Derived>
         class JsonOperators
@@ -179,6 +181,10 @@ namespace BlackMisc
 
         /*!
          * CRTP class template from which a derived class can inherit common methods dealing with JSON by metatuple.
+         *
+         * \tparam Derived Must be registered with BLACK_DECLARE_TUPLE_CONVERSION.
+         *
+         * \see BLACKMISC_DECLARE_USING_MIXIN_JSON
          */
         template <class Derived>
         class JsonByTuple : public JsonOperators<Derived>, private Private::EncapsulationBreaker

src/blackmisc/propertyindexvariantmap.h

@@ -29,6 +29,9 @@ namespace BlackMisc
     {
         /*!
          * CRTP class template from which a derived class can inherit property indexing functions.
+         *
+         * This is only a placeholder for future support of implementing property indexing through the tuple system.
+         * At the moment, it just implements the default properties: String, Icon, and Pixmap.
          */
         template <class Derived>
         class Index

src/blackmisc/valueobject.h

@@ -60,11 +60,8 @@ namespace BlackMisc
     };
 
     /*!
-     * Standard implementation of CValueObject using meta tuple system.
+     * Mix of the most commonly used mixin classes.
-     *
+     * \see BlackMisc::Mixin
-     * This uses policy-based design. Specialize the class template CValueObjectPolicy
-     * to specify different policy classes.
-     *
      * \tparam Derived  The class which is inheriting from this one (CRTP).
      * \tparam Base     The class which this one shall inherit from (default is CEmpty,
      *                  but this can be changed to create a deeper inheritance hierarchy).

src/blackmisc/variant.h

@@ -36,6 +36,8 @@ namespace BlackMisc
 
         /*!
          * CRTP class template from which a derived class can inherit common methods dealing with the metatype of the class.
+         *
+         * \see BLACKMISC_DECLARE_USING_MIXIN_METATYPE
          */
         template <class Derived, class... AdditionalTypes>
         class MetaType
@@ -95,6 +97,8 @@ namespace BlackMisc
 
         /*!
          * Variant of MetaType mixin which also registers QList<Derived> with the type system.
+         *
+         * \see BLACKMISC_DECLARE_USING_MIXIN_METATYPE_AND_QLIST
          */
         template <class Derived>
         class MetaTypeAndQList : public MetaType<Derived, QList<Derived>>