Update the style of the Haiku Book to resemble the User Guide.
If you have never seen this before you are in for a bit of a shock. Update the Doxyfile to 1.7.3 (the version that gets auto-generated). Update the book.dox front page with some nice introductory text. Add new documentation for the following classes: BCheckBox BClipboard BColorControl BControl BEntryList BView (preliminary) Remove redundant documentation from src/kits/storage/EntryList.cpp Minor documentation update for the following classes: BAlert BApplication BArchivable BBox BButton BCatalog BFindDirectory BHandler BUnarchiver BString git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43096 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
+16
-16
@@ -207,15 +207,15 @@
|
||||
/*!
|
||||
\fn void BHandler::MessageReceived(BMessage *message)
|
||||
\brief Handle a message that has been received by the associated looper.
|
||||
|
||||
This method is reimplemented in your subclasses. If the messages that have
|
||||
|
||||
This method is reimplemented by subclasses. If the messages that have
|
||||
been received by a looper pass through the filters, then they end up in
|
||||
the MessageReceived() methods.
|
||||
|
||||
The example shows a very common way to handle message. Usually, this
|
||||
involves parsing the BMessage::what constant and then perform an action
|
||||
based on that.
|
||||
|
||||
|
||||
The example below shows a very common way to handle message. Usually,
|
||||
this involves parsing the BMessage::what constant and then perform an
|
||||
action based on that.
|
||||
|
||||
\code
|
||||
void
|
||||
ShowImageApp::MessageReceived(BMessage *message)
|
||||
@@ -239,14 +239,14 @@ ShowImageApp::MessageReceived(BMessage *message)
|
||||
}
|
||||
\endcode
|
||||
|
||||
If your handler cannot process this message, you should pass it on to the
|
||||
base class. Eventually, it will reach the default implementation, which
|
||||
will reply with a \c B_MESSAGE_NOT_UNDERSTOOD constant.
|
||||
|
||||
\attention If you want to keep or manipulate the \a message, have a look
|
||||
at the \link BLooper::DetachCurrentMessage() DetachCurrentMessage() \endlink
|
||||
method to get ownership of the message.
|
||||
|
||||
If your handler cannot process this message, you should pass it on
|
||||
to the base class. Eventually, it will reach the base implementation,
|
||||
which will reply with \c B_MESSAGE_NOT_UNDERSTOOD.
|
||||
|
||||
\attention If you want to keep or manipulate the \a message, have a
|
||||
look at BLooper::DetachCurrentMessage() to receive ownership of
|
||||
the message.
|
||||
|
||||
\param message The message that needs to be handled.
|
||||
*/
|
||||
|
||||
@@ -254,7 +254,7 @@ ShowImageApp::MessageReceived(BMessage *message)
|
||||
/*!
|
||||
\fn BLooper *BHandler::Looper() const
|
||||
\brief Return a pointer to the looper that this handler is associated with.
|
||||
|
||||
|
||||
\return If the handler is not yet associated with a looper, it will return
|
||||
\c NULL.
|
||||
\see BLooper::AddHandler()
|
||||
|
||||
Reference in New Issue
Block a user