Move app and support class docs from libbe to libroot.
Also a few more style and spelling fixes.
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
*/
|
||||
|
||||
|
||||
@@ -21,6 +21,7 @@
|
||||
/*!
|
||||
\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
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
/*!
|
||||
\file Archivable.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Provides the BArchivable interface and declares the BArchiver and
|
||||
BUnarchiver classes.
|
||||
*/
|
||||
@@ -28,7 +28,7 @@
|
||||
/*!
|
||||
\class BArchivable
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Interface for objects that can be archived into a BMessage.
|
||||
|
||||
BArchivable provides an interface for objects that can be put into message
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
/*!
|
||||
\file Archivable.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Contains BArchiver class.
|
||||
*/
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
/*!
|
||||
\class BArchiver
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief A class that simplifies the archiving of complicated BArchivable
|
||||
hierarchies.
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
/*!
|
||||
\file Autolock.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Implements a handy locking utility.
|
||||
*/
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
/*!
|
||||
\class BAutolock
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Convenient utility to make parts of your code thread-safe easily.
|
||||
|
||||
The autolocker uses a BLooper or a BLocker in order to protect a part
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
/*!
|
||||
\file Beep.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Functions to generate sounds from the computer.
|
||||
*/
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
/*!
|
||||
\file BlockCache.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Implements a mechanism to store and retrieve memory blocks.
|
||||
*/
|
||||
|
||||
@@ -40,7 +40,7 @@
|
||||
/*!
|
||||
\class BBlockCache
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief A class that creates and maintains a pool of memory blocks.
|
||||
|
||||
In some performance critical code there might come a time where you require
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
/*!
|
||||
\file BufferIO.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Provides the BBufferIO class.
|
||||
*/
|
||||
|
||||
@@ -23,9 +23,8 @@
|
||||
/*!
|
||||
\class BBufferIO
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief A buffered adapter for BPositionIO objects.
|
||||
\author Stefano Ceccherini \<[email protected]\>
|
||||
|
||||
This class differs from other classes derived from BPositionIO in a sense
|
||||
that it does not actually provide an actual entity to be read or written
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
/*!
|
||||
\file DataIO.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Defines abstract BDataIO and BPositionIO and the derived BMallocIO and BMemoryIO classes.
|
||||
|
||||
Pure virtual BDataIO and BPositioIO classes provide
|
||||
@@ -32,7 +32,7 @@
|
||||
/*!
|
||||
\class BDataIO
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Abstract interface for objects that provide read and write access to
|
||||
data.
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
/*!
|
||||
\file Flattenable.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Provides the BFlattenable interface
|
||||
*/
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
/*!
|
||||
\class BFlattenable
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Interface for classes that can flatten and unflatten themselves to
|
||||
a stream of bytes.
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
/*!
|
||||
\file List.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Defines the BList class.
|
||||
*/
|
||||
|
||||
@@ -27,7 +27,7 @@
|
||||
/*!
|
||||
\class BList
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief An ordered container that is designed to hold generic \c void*
|
||||
objects.
|
||||
|
||||
|
||||
@@ -13,14 +13,15 @@
|
||||
/*!
|
||||
\file Locker.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Provides locking class BLocker.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\class BLocker
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Semaphore-type class for thread safety.
|
||||
|
||||
The BLocker interface is not merely a wrapper around a semaphore, but it
|
||||
@@ -29,10 +30,10 @@
|
||||
because before it uses the internal semaphore, it first checks against a
|
||||
variable that is only operated on with atomic operations. Setting a variable
|
||||
is a lot more efficient than acquiring a semaphore, thus this type of locking
|
||||
is much prefered.
|
||||
is much preferred.
|
||||
|
||||
It basically works as follows. Whenever you newly created BLocker object
|
||||
recieves a locking request, it atomically sets the benaphore variable to
|
||||
receives a locking request, it atomically sets the benaphore variable to
|
||||
\c 1. Then only additional calls from different threads will utilize the
|
||||
semaphore. You can imagine that in many cases where you protect
|
||||
of data that \em might be accessed by two or more concurrent threads, but
|
||||
@@ -42,7 +43,7 @@
|
||||
The other feature of BLocker that improves basic semaphore handling is that
|
||||
it allows for recursive locks. The following piece of code works with a
|
||||
BLocker, but block inevitably with a semaphore. Let's pretend I call
|
||||
\c Water():
|
||||
\c Water():
|
||||
|
||||
\code
|
||||
status_t
|
||||
@@ -76,11 +77,12 @@ Flower::Water(int amount)
|
||||
pair every Lock() with an Unlock() though, or you'll create a deadlock.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BLocker::BLocker()
|
||||
\brief Constructor.
|
||||
|
||||
Create a new BLocker with the default name of <tt>some BLocker</tt>. This
|
||||
Create a new BLocker with the default name of some BLocker. This
|
||||
BLocker will use the benaphore-style locking.
|
||||
|
||||
\note For debugging purposes, it's extremely convenient to actually give a
|
||||
@@ -90,6 +92,7 @@ Flower::Water(int amount)
|
||||
\see BLocker(const char* name, bool benaphoreStyle) for all the options.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BLocker::BLocker(const char* name)
|
||||
\brief Constructor.
|
||||
@@ -104,6 +107,7 @@ Flower::Water(int amount)
|
||||
\see BLocker(const char* name, bool benaphoreStyle) for all the options.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BLocker::BLocker(bool benaphoreStyle)
|
||||
\brief Constructor.
|
||||
@@ -123,6 +127,7 @@ Flower::Water(int amount)
|
||||
to set a name.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BLocker::BLocker(const char* name, bool benaphoreStyle)
|
||||
\brief Constructor.
|
||||
@@ -137,6 +142,7 @@ Flower::Water(int amount)
|
||||
for its functioning.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn virtual BLocker::~BLocker()
|
||||
\brief Destructor.
|
||||
@@ -146,11 +152,12 @@ Flower::Water(int amount)
|
||||
those calls.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn bool BLocker::Lock()
|
||||
\brief Add a lock request and block on it until we get it.
|
||||
|
||||
\retval true Lock acquired succesfully.
|
||||
\retval true Lock acquired successfully.
|
||||
\retval false Failed to acquire the lock. Most probable cause is that the
|
||||
object is deleted. This frees the semaphore and releases the
|
||||
pending Lock() requests.
|
||||
@@ -158,6 +165,7 @@ Flower::Water(int amount)
|
||||
\see LockWithTimeout(bigtime_t timeout), Unlock()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BLocker::LockWithTimeout(bigtime_t timeout)
|
||||
\brief Add a lock request and block until we get it or until it times out.
|
||||
@@ -168,17 +176,20 @@ Flower::Water(int amount)
|
||||
\see Lock(), Unlock()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BLocker::Unlock(void)
|
||||
\brief Release the lock that's currently held.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn thread_id BLocker::LockingThread(void) const
|
||||
\brief Return the \c thread_id of the thread that's currently holding the
|
||||
lock.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn bool BLocker::IsLocked(void) const
|
||||
\brief Check if the calling thread is actually holding the lock.
|
||||
@@ -188,16 +199,19 @@ Flower::Water(int amount)
|
||||
\retval false The object is unlocked or the lock is held by another thread.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn int32 BLocker::CountLocks(void) const
|
||||
\brief Return the number of recursive locks that are currently held.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn nt32 BLocker::CountLockRequests(void) const
|
||||
\brief Return the number of threads with a pending lock request.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn sem_id BLocker::Sem(void) const
|
||||
\brief Return the sem_id of the semaphore this object holds.
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
/*!
|
||||
\class BString String.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief String class supporting common string operations.
|
||||
|
||||
BString is a string allocation and manipulation class. The object
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
/*!
|
||||
\file SupportDefs.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief Defines basic types and definitions for the Haiku API.
|
||||
*/
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
/*!
|
||||
\class BUnarchiver
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief A class that simplifies the unarchiving of complicated BArchivable
|
||||
hierarchies.
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
/*!
|
||||
\class BStopWatch
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\ingroup libroot
|
||||
\brief A timer class.
|
||||
|
||||
This class provides method to time events. The interface is designed to
|
||||
|
||||
Reference in New Issue
Block a user