refs #91 using \private command in Doxygen comments as appropriate

This commit is contained in:
Mathew Sutcliffe
2014-02-11 23:09:08 +00:00
parent 697fd0863e
commit fb8efb2720
3 changed files with 8 additions and 24 deletions

View File

@@ -113,11 +113,7 @@ namespace BlackCore
void update();
signals:
/*!
* Used internally to terminate the connection from within a callback
* \internal
*/
void terminate();
void terminate(); //!< \private
public:
//! Deletion policy for QScopedPointer

View File

@@ -50,8 +50,8 @@
*/
/*!
* \internal
* \namespace BlackMisc::Predicates::Private
* \private
*/
/*!

View File

@@ -23,58 +23,46 @@ namespace BlackMisc
namespace Private
{
//! For internal use of BlackMisc::Predicates
//! \private
template <class...> struct MemberEqual;
//! For internal use of BlackMisc::Predicates
//! \private
template <class T, class M, class V> struct MemberEqual<T, M, V>
{
//! \brief
//! @{
M m;
V v;
MemberEqual(M m_, V v_) : m(m_), v(v_) {}
bool operator()(const T &obj) const { return (obj.*m)() == v; }
//! @}
};
//! For internal use of BlackMisc::Predicates
//! \private
template <class T, class M, class V, class... Tail> struct MemberEqual<T, M, V, Tail...>
{
//! \brief
//! @{
MemberEqual<T, M, V> head;
MemberEqual<T, Tail...> tail;
MemberEqual(M m, V v, Tail... tail_) : head(m, v), tail(tail_...) {}
bool operator()(const T &obj) const { return head(obj) && tail(obj); }
//! @}
};
//! For internal use of BlackMisc::Predicates
//! \private
template <class...> struct MemberLess;
//! For internal use of BlackMisc::Predicates
//! \private
template <class T, class M> struct MemberLess<T, M>
{
//! \brief
//! @{
M m;
MemberLess(M m_) : m(m_) {}
bool operator()(const T &a, const T &b) const { return (a.*m)() < (b.*m)(); }
bool isStable(const T &a, const T &b) const { return (a.*m)() != (b.*m)(); }
//! @}
};
//! For internal use of BlackMisc::Predicates
//! \private
template <class T, class M, class... Tail> struct MemberLess<T, M, Tail...>
{
//! \brief
//! @{
MemberLess<T, M> head;
MemberLess<T, Tail...> tail;
MemberLess(M m, Tail... tail_) : head(m), tail(tail_...) {}
bool operator()(const T &a, const T &b) const { return head.isStable(a, b) ? head(a, b) : tail(a, b); }
//! @}
};
} //namespace Private