Aren
/
haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move the operator function docs over too

This commit is contained in:
John Scipione 2015-01-16 16:42:45 -05:00
parent 973984649c
commit fd3c25a928
2 changed files with 28 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/user/app/Messenger.dox
View File

@ -16,7 +16,8 @@
\file Messenger.h
\ingroup app
\ingroup libbe
\brief Provides the BMessenger class.
\brief Provides the BMessenger class and some BMessenger operator
functions.
*/
@ -479,3 +480,28 @@
\since Haiku R1
*/
/*!
\fn bool operator<(const BMessenger& _a, const BMessenger& _b)
\brief Returns whether the first messenger is less than the second one.
This method defines an order on BMessengers based on their member
variables \c fPort, \c fHandlerToken and \c fPreferredTarget.
\param _a The first messenger.
\param _b The second messenger.
\return \c true, if \a a was less than \a b, \c false otherwise.
*/
/*! \fn bool operator!=(const BMessenger& a, const BMessenger& b)
\brief Returns whether two BMessengers do NOT have the same target.
\param a The first messenger.
\param b The second messenger.
\return \c false, if \a a and \a b had the same targets or both were not
properly initialized, \c true otherwise.
*/

18
src/kits/app/Messenger.cpp
View File

@ -415,17 +415,9 @@ BMessenger::_InitData(const BHandler* handler, const BLooper* looper,
}
/*! Returns whether the first one of two BMessengers is less than the
second one.
// #pragma mark - Operator functions
This method defines an order on BMessengers based on their member
variables \c fPort, \c fHandlerToken and \c fPreferredTarget.
\param a The first messenger.
\param b The second messenger.
\return \c true, if \a a is less than \a b, \c false otherwise.
*/
bool
operator<(const BMessenger& _a, const BMessenger& _b)
{
@ -446,14 +438,6 @@ operator<(const BMessenger& _a, const BMessenger& _b)
}
/*! Returns whether two BMessengers have not the same target.
\param a The first messenger.
\param b The second messenger.
\return \c false, if \a a and \a b have the same targets or are both not
properly initialized, \c true otherwise.
*/
bool
operator!=(const BMessenger& a, const BMessenger& b)
{