flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-04-14 00:25:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

refs #413 Doxygen.

Browse Source
This commit is contained in:
Mathew Sutcliffe
2015-05-05 22:24:28 +01:00
parent 5a91d761c2
commit 2f66785c63
7 changed files with 33 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/blackmisc/blackmiscfreefunctions.h
View File

@@ -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

6
src/blackmisc/compare.h
View File

@@ -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

6
src/blackmisc/dbus.h
View File

@@ -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

6
src/blackmisc/json.h
View File

@@ -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

3
src/blackmisc/propertyindexvariantmap.h
View File

@@ -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

7
src/blackmisc/valueobject.h
View File

@@ -60,11 +60,8 @@ namespace BlackMisc
};
/*!
* Standard implementation of CValueObject using meta tuple system.
*
* This uses policy-based design. Specialize the class template CValueObjectPolicy
* to specify different policy classes.
*
* Mix of the most commonly used mixin classes.
* \see BlackMisc::Mixin
* \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).

4
src/blackmisc/variant.h
View File

@@ -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>>