[haiku-commits] haiku: hrev45222 - in docs/user: app locale storage
- From: jscipione@xxxxxxxxx
- To: haiku-commits@xxxxxxxxxxxxx
- Date: Thu, 31 Jan 2013 01:51:28 +0100 (CET)
hrev45222 adds 4 changesets to branch 'master'
old head: ce5b408f1f6b6a0372229ca45911abb03c7d1073
new head: ec96e7af1a0ac6dd9fc51dc3f88a5344154a002b
overview: http://cgit.haiku-os.org/haiku/log/?qt=range&q=ec96e7a+%5Ece5b408
----------------------------------------------------------------------------
bf20349: Correct a few more param instances in BHandler docs
8bbea12: Use the version from the cpp file, not the header for \fn
400a2a1: Fix warning in DurationFormat.dox
ec96e7a: Fix warning in FilePanel.dox
[ John Scipione <jscipione@xxxxxxxxx> ]
----------------------------------------------------------------------------
3 files changed, 15 insertions(+), 16 deletions(-)
docs/user/app/Handler.dox | 26 +++++++++++++-------------
docs/user/locale/DurationFormat.dox | 3 +--
docs/user/storage/FilePanel.dox | 2 +-
############################################################################
Commit: bf20349b341c31601568c9d1f8379b938d349600
URL: http://cgit.haiku-os.org/haiku/commit/?id=bf20349
Author: John Scipione <jscipione@xxxxxxxxx>
Date: Thu Jan 31 00:35:50 2013 UTC
Correct a few more param instances in BHandler docs
----------------------------------------------------------------------------
diff --git a/docs/user/app/Handler.dox b/docs/user/app/Handler.dox
index 4f61593..aaa0612 100644
--- a/docs/user/app/Handler.dox
+++ b/docs/user/app/Handler.dox
@@ -207,13 +207,13 @@
/*!
\fn void BHandler::MessageReceived(BMessage *message)
- \brief Handle a message that has been received by the associated looper.
+ \brief Handle \a message that has been received by the associated
looper.
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 below shows a very common way to handle message. Usually,
+ The example below shows a very common way to handle \a message. Usually,
this involves parsing the BMessage::what constant and then perform an
action based on that.
@@ -240,13 +240,13 @@ ShowImageApp::MessageReceived(BMessage *message)
}
\endcode
- If your handler cannot process this message, you should pass it on
+ If your handler cannot process this \a 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.
+ the \a message.
\param message The message that needs to be handled.
*/
@@ -321,13 +321,13 @@ ShowImageApp::MessageReceived(BMessage *message)
/*!
\fn void BHandler::AddFilter(BMessageFilter *filter)
- \brief Add a filter as a prerequisite to this handler.
+ \brief Add \a filter as a prerequisite to this handler.
If the handler is associated with a looper, this looper needs to be
locked
in order for this operation to succeed.
- Note that the filter is not copied, rather a pointer to the filter is
- stored. As such, you need to make sure that the filter object exists as
+ Note that the filter is not copied, rather a pointer to the \a filter is
+ stored. As such, you need to make sure that the \a filter object exists
as
long as it is added to this handler.
\see RemoveFilter(), SetFilterList()
@@ -336,16 +336,16 @@ ShowImageApp::MessageReceived(BMessage *message)
/*!
\fn bool BHandler::RemoveFilter(BMessageFilter *filter)
- \brief Remove a filter from the filter list.
+ \brief Remove \a filter from the filter list.
If the handler is associated with a looper, this looper needs to be
locked
in order for this operation to succeed.
- Note that the filter is not deleted, merely removed from the list. You
need
- to take care of the memory yourself.
+ Note that the \a filter is not deleted, merely removed from the list.
You
+ need to take care of the memory yourself.
- \retval true The filter was in the filter list and is removed.
- \retval false The filter was not found in the filter list.
+ \retval true The \a filter was in the filter list and is removed.
+ \retval false The \a filter was not found in the filter list.
\see AddFilter(), FilterList()
*/
############################################################################
Commit: 8bbea122eb1f9b63baefcfd374b073ca6ec25d3c
URL: http://cgit.haiku-os.org/haiku/commit/?id=8bbea12
Author: John Scipione <jscipione@xxxxxxxxx>
Date: Thu Jan 31 00:38:55 2013 UTC
Use the version from the cpp file, not the header for \fn
----------------------------------------------------------------------------
diff --git a/docs/user/app/Handler.dox b/docs/user/app/Handler.dox
index aaa0612..33fc2a0e 100644
--- a/docs/user/app/Handler.dox
+++ b/docs/user/app/Handler.dox
@@ -119,7 +119,7 @@
/*!
- \fn BHandler::BHandler(const char* name = NULL)
+ \fn BHandler::BHandler(const char *name)
\brief Construct a new handler with a \a name.
The newly constructed handler is not associated with a looper until you
############################################################################
Commit: 400a2a18134996a50644e12a8cae11e53534fdfc
URL: http://cgit.haiku-os.org/haiku/commit/?id=400a2a1
Author: John Scipione <jscipione@xxxxxxxxx>
Date: Thu Jan 31 00:50:41 2013 UTC
Fix warning in DurationFormat.dox
----------------------------------------------------------------------------
diff --git a/docs/user/locale/DurationFormat.dox
b/docs/user/locale/DurationFormat.dox
index 7f47e10..b35c57f 100644
--- a/docs/user/locale/DurationFormat.dox
+++ b/docs/user/locale/DurationFormat.dox
@@ -50,8 +50,7 @@
/*!
- \fn BDurationFormat&
- BDurationFormat::operator=(const BDurationFormat& other)
+ \fn BDurationFormat& BDurationFormat::operator=(const BDurationFormat&
other)
\brief Assignment overload.
\param other The BDurationFormat object to copy from.
############################################################################
Revision: hrev45222
Commit: ec96e7af1a0ac6dd9fc51dc3f88a5344154a002b
URL: http://cgit.haiku-os.org/haiku/commit/?id=ec96e7a
Author: John Scipione <jscipione@xxxxxxxxx>
Date: Thu Jan 31 00:51:01 2013 UTC
Fix warning in FilePanel.dox
----------------------------------------------------------------------------
diff --git a/docs/user/storage/FilePanel.dox b/docs/user/storage/FilePanel.dox
index b952ae4..b04804c 100644
--- a/docs/user/storage/FilePanel.dox
+++ b/docs/user/storage/FilePanel.dox
@@ -62,7 +62,7 @@
/*!
- \fn virtual bool Filter(const entry_ref* ref, BNode* node,
+ \fn virtual bool BRefFilter::Filter(const entry_ref* ref, BNode* node,
struct stat_beos* stat, const char* mimeType)
\brief Hook method that's called on each file in the target directory
displayed by a file panel.
Other related posts:
- » [haiku-commits] haiku: hrev45222 - in docs/user: app locale storage - jscipione
