Move app and support class docs from libbe to libroot.

Also a few more style and spelling fixes.
This commit is contained in:
John Scipione
2013-02-07 14:19:09 -05:00
parent 6dc7e05ecf
commit db5b891db2
22 changed files with 75 additions and 62 deletions
+1 -1
View File
@@ -22,7 +22,7 @@
/*!
\class BApplication
\ingroup app
\ingroup libbe
\ingroup libroot
\brief A container object for an application.
A BApplication establishes a connection between the application and the
+1 -1
View File
@@ -29,7 +29,7 @@
/*!
\class BClipboard
\ingroup app
\ingroup libbe
\ingroup libroot
\brief Used for short-term data storage between documents and
applications via copy and paste operations.
+1 -1
View File
@@ -202,7 +202,7 @@
/*!
\class BCursor
\ingroup app
\ingroup libbe
\ingroup libroot
\brief BCursor describes a view-wide or application-wide cursor.
\note As BeOS only supports 16x16 monochrome cursors, to see a nice
+1 -1
View File
@@ -55,7 +55,7 @@
/*!
\class BHandler
\ingroup app
\ingroup libbe
\ingroup libroot
\brief Handles messages that are passed on by a BLooper.
The BHandler class implements two important pieces of functionality. It
+1 -1
View File
@@ -27,7 +27,7 @@
/*!
\class BLooper
\ingroup app
\ingroup libbe
\ingroup libroot
\brief Receive and process messages in a separate thread.
When an object of this class is created, the message loop can be started
+1 -1
View File
@@ -92,7 +92,7 @@
/*!
\class BMessage
\ingroup app
\ingroup libbe
\ingroup libroot
\brief A container that can be send and received using the Haiku messaging
subsystem.
+1 -2
View File
@@ -143,7 +143,7 @@
/*!
\class BMessageFilter
\ingroup app
\ingroup libbe
\ingroup libroot
\brief Describes a message filter for BLooper and BHandler.
Objects of this class serve as a description of properties that incoming
@@ -334,4 +334,3 @@ looper->AddCommonFilter(filter);
\fn BLooper *BMessageFilter::Looper() const
\brief Return the looper this filter is associated with.
*/
+13 -12
View File
@@ -21,17 +21,18 @@
/*!
\class BMessageQueue
\ingroup app
\ingroup libroot
\brief A container that maintains a queue of messages.
This class is used by BLooper to maintain a queue of messages that need to
be processed. This class has been designed as a first in, first out
container.
The default message handling of a BLooper probably suffices for most uses,
but if you want more control, you can perform operations using the methods
of this class. Use BLooper::MessageQueue() to retrieve the specific
BMessageQueue instance.
Note that you are encouraged to make sure that whichever operation you
perform, that you only do this after the object has been locked (see
Lock()). The most important method, NextMessage() will fail if you have not
@@ -67,7 +68,7 @@
The message has to be allocated on the heap with \c new, because the queue
claims ownership of the message. Messages that were constructed on the
stack will corrupt the queue.
Because a BMessageQueue claims ownership of the \a message, it is important
that the message does not belong to another BMessageQueue.
*/
@@ -76,7 +77,7 @@
/*!
\fn void BMessageQueue::RemoveMessage(BMessage* message)
\brief Remove a \a message from the queue.
If the \a message is indeed associated with this queue, it is removed from
it. This effectively means that you regain ownership of the message.
*/
@@ -97,9 +98,9 @@
/*!
\fn BMessage *BMessageQueue::FindMessage(int32 index) const
\brief Retrieve the message at the \a index of this queue.
\param index A zero-based index of the message you want to retrieve.
\return A pointer to a message, or \c NULL if the \a index is out of
bounds.
\see FindMessage(uint32, int32) for a variant that takes a specific \c what
@@ -114,7 +115,7 @@
\param index A zero-based index of the message you want to retrieve.
\param what The \a what code of the message.
\return A pointer to a message, or \c NULL if there is no message at the
\a index with that \a what constant, or if the \a index is out of
bounds.
@@ -124,7 +125,7 @@
/*!
\fn bool BMessageQueue::Lock()
\brief Lock the queue so no other thread can perform operations on it.
\see Unlock()
*/
@@ -132,7 +133,7 @@
/*!
\fn void BMessageQueue::Unlock()
\brief Unlock the queue after a Lock() request.
\see Lock()
*/
@@ -148,10 +149,10 @@
/*!
\fn BMessage *BMessageQueue::NextMessage()
\brief Remove the first BMessage on the queue and return it to the caller.
After calling this method, you get the ownership of the message, so make
sure it is deleted after you are done.
\return A pointer to a message, or \c NULL if the queue is empty, or the
object has not been properly locked.
\see Lock()