refs #413 Doxygen.

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

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