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 \class BApplication
\ingroup app \ingroup app
\ingroup libbe \ingroup libroot
\brief A container object for an application. \brief A container object for an application.
A BApplication establishes a connection between the application and the A BApplication establishes a connection between the application and the
+1 -1
View File
@@ -29,7 +29,7 @@
/*! /*!
\class BClipboard \class BClipboard
\ingroup app \ingroup app
\ingroup libbe \ingroup libroot
\brief Used for short-term data storage between documents and \brief Used for short-term data storage between documents and
applications via copy and paste operations. applications via copy and paste operations.
+1 -1
View File
@@ -202,7 +202,7 @@
/*! /*!
\class BCursor \class BCursor
\ingroup app \ingroup app
\ingroup libbe \ingroup libroot
\brief BCursor describes a view-wide or application-wide cursor. \brief BCursor describes a view-wide or application-wide cursor.
\note As BeOS only supports 16x16 monochrome cursors, to see a nice \note As BeOS only supports 16x16 monochrome cursors, to see a nice
+1 -1
View File
@@ -55,7 +55,7 @@
/*! /*!
\class BHandler \class BHandler
\ingroup app \ingroup app
\ingroup libbe \ingroup libroot
\brief Handles messages that are passed on by a BLooper. \brief Handles messages that are passed on by a BLooper.
The BHandler class implements two important pieces of functionality. It The BHandler class implements two important pieces of functionality. It
+1 -1
View File
@@ -27,7 +27,7 @@
/*! /*!
\class BLooper \class BLooper
\ingroup app \ingroup app
\ingroup libbe \ingroup libroot
\brief Receive and process messages in a separate thread. \brief Receive and process messages in a separate thread.
When an object of this class is created, the message loop can be started When an object of this class is created, the message loop can be started
+1 -1
View File
@@ -92,7 +92,7 @@
/*! /*!
\class BMessage \class BMessage
\ingroup app \ingroup app
\ingroup libbe \ingroup libroot
\brief A container that can be send and received using the Haiku messaging \brief A container that can be send and received using the Haiku messaging
subsystem. subsystem.
+1 -2
View File
@@ -143,7 +143,7 @@
/*! /*!
\class BMessageFilter \class BMessageFilter
\ingroup app \ingroup app
\ingroup libbe \ingroup libroot
\brief Describes a message filter for BLooper and BHandler. \brief Describes a message filter for BLooper and BHandler.
Objects of this class serve as a description of properties that incoming Objects of this class serve as a description of properties that incoming
@@ -334,4 +334,3 @@ looper->AddCommonFilter(filter);
\fn BLooper *BMessageFilter::Looper() const \fn BLooper *BMessageFilter::Looper() const
\brief Return the looper this filter is associated with. \brief Return the looper this filter is associated with.
*/ */
+1
View File
@@ -21,6 +21,7 @@
/*! /*!
\class BMessageQueue \class BMessageQueue
\ingroup app \ingroup app
\ingroup libroot
\brief A container that maintains a queue of messages. \brief A container that maintains a queue of messages.
This class is used by BLooper to maintain a queue of messages that need to This class is used by BLooper to maintain a queue of messages that need to
+2 -2
View File
@@ -19,7 +19,7 @@
/*! /*!
\file Archivable.h \file Archivable.h
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Provides the BArchivable interface and declares the BArchiver and \brief Provides the BArchivable interface and declares the BArchiver and
BUnarchiver classes. BUnarchiver classes.
*/ */
@@ -28,7 +28,7 @@
/*! /*!
\class BArchivable \class BArchivable
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Interface for objects that can be archived into a BMessage. \brief Interface for objects that can be archived into a BMessage.
BArchivable provides an interface for objects that can be put into message BArchivable provides an interface for objects that can be put into message
+2 -2
View File
@@ -14,7 +14,7 @@
/*! /*!
\file Archivable.h \file Archivable.h
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Contains BArchiver class. \brief Contains BArchiver class.
*/ */
@@ -22,7 +22,7 @@
/*! /*!
\class BArchiver \class BArchiver
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief A class that simplifies the archiving of complicated BArchivable \brief A class that simplifies the archiving of complicated BArchivable
hierarchies. hierarchies.
+2 -2
View File
@@ -13,7 +13,7 @@
/*! /*!
\file Autolock.h \file Autolock.h
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Implements a handy locking utility. \brief Implements a handy locking utility.
*/ */
@@ -21,7 +21,7 @@
/*! /*!
\class BAutolock \class BAutolock
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Convenient utility to make parts of your code thread-safe easily. \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 The autolocker uses a BLooper or a BLocker in order to protect a part
+1 -1
View File
@@ -19,7 +19,7 @@
/*! /*!
\file Beep.h \file Beep.h
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Functions to generate sounds from the computer. \brief Functions to generate sounds from the computer.
*/ */
+2 -2
View File
@@ -18,7 +18,7 @@
/*! /*!
\file BlockCache.h \file BlockCache.h
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Implements a mechanism to store and retrieve memory blocks. \brief Implements a mechanism to store and retrieve memory blocks.
*/ */
@@ -40,7 +40,7 @@
/*! /*!
\class BBlockCache \class BBlockCache
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief A class that creates and maintains a pool of memory blocks. \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 In some performance critical code there might come a time where you require
+2 -3
View File
@@ -15,7 +15,7 @@
/*! /*!
\file BufferIO.h \file BufferIO.h
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Provides the BBufferIO class. \brief Provides the BBufferIO class.
*/ */
@@ -23,9 +23,8 @@
/*! /*!
\class BBufferIO \class BBufferIO
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief A buffered adapter for BPositionIO objects. \brief A buffered adapter for BPositionIO objects.
\author Stefano Ceccherini \<[email protected]\>
This class differs from other classes derived from BPositionIO in a sense 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 that it does not actually provide an actual entity to be read or written
+2 -2
View File
@@ -15,7 +15,7 @@
/*! /*!
\file DataIO.h \file DataIO.h
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Defines abstract BDataIO and BPositionIO and the derived BMallocIO and BMemoryIO classes. \brief Defines abstract BDataIO and BPositionIO and the derived BMallocIO and BMemoryIO classes.
Pure virtual BDataIO and BPositioIO classes provide Pure virtual BDataIO and BPositioIO classes provide
@@ -32,7 +32,7 @@
/*! /*!
\class BDataIO \class BDataIO
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Abstract interface for objects that provide read and write access to \brief Abstract interface for objects that provide read and write access to
data. data.
+2 -2
View File
@@ -14,7 +14,7 @@
/*! /*!
\file Flattenable.h \file Flattenable.h
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Provides the BFlattenable interface \brief Provides the BFlattenable interface
*/ */
@@ -22,7 +22,7 @@
/*! /*!
\class BFlattenable \class BFlattenable
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Interface for classes that can flatten and unflatten themselves to \brief Interface for classes that can flatten and unflatten themselves to
a stream of bytes. a stream of bytes.
+2 -2
View File
@@ -19,7 +19,7 @@
/*! /*!
\file List.h \file List.h
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Defines the BList class. \brief Defines the BList class.
*/ */
@@ -27,7 +27,7 @@
/*! /*!
\class BList \class BList
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief An ordered container that is designed to hold generic \c void* \brief An ordered container that is designed to hold generic \c void*
objects. objects.
+21 -7
View File
@@ -13,14 +13,15 @@
/*! /*!
\file Locker.h \file Locker.h
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Provides locking class BLocker. \brief Provides locking class BLocker.
*/ */
/*! /*!
\class BLocker \class BLocker
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Semaphore-type class for thread safety. \brief Semaphore-type class for thread safety.
The BLocker interface is not merely a wrapper around a semaphore, but it 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 because before it uses the internal semaphore, it first checks against a
variable that is only operated on with atomic operations. Setting a variable 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 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 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 \c 1. Then only additional calls from different threads will utilize the
semaphore. You can imagine that in many cases where you protect 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 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 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 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 BLocker, but block inevitably with a semaphore. Let's pretend I call
\c Water(): \c Water():
\code \code
status_t status_t
@@ -76,11 +77,12 @@ Flower::Water(int amount)
pair every Lock() with an Unlock() though, or you'll create a deadlock. pair every Lock() with an Unlock() though, or you'll create a deadlock.
*/ */
/*! /*!
\fn BLocker::BLocker() \fn BLocker::BLocker()
\brief Constructor. \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. BLocker will use the benaphore-style locking.
\note For debugging purposes, it's extremely convenient to actually give a \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. \see BLocker(const char* name, bool benaphoreStyle) for all the options.
*/ */
/*! /*!
\fn BLocker::BLocker(const char* name) \fn BLocker::BLocker(const char* name)
\brief Constructor. \brief Constructor.
@@ -104,6 +107,7 @@ Flower::Water(int amount)
\see BLocker(const char* name, bool benaphoreStyle) for all the options. \see BLocker(const char* name, bool benaphoreStyle) for all the options.
*/ */
/*! /*!
\fn BLocker::BLocker(bool benaphoreStyle) \fn BLocker::BLocker(bool benaphoreStyle)
\brief Constructor. \brief Constructor.
@@ -123,6 +127,7 @@ Flower::Water(int amount)
to set a name. to set a name.
*/ */
/*! /*!
\fn BLocker::BLocker(const char* name, bool benaphoreStyle) \fn BLocker::BLocker(const char* name, bool benaphoreStyle)
\brief Constructor. \brief Constructor.
@@ -137,6 +142,7 @@ Flower::Water(int amount)
for its functioning. for its functioning.
*/ */
/*! /*!
\fn virtual BLocker::~BLocker() \fn virtual BLocker::~BLocker()
\brief Destructor. \brief Destructor.
@@ -146,11 +152,12 @@ Flower::Water(int amount)
those calls. those calls.
*/ */
/*! /*!
\fn bool BLocker::Lock() \fn bool BLocker::Lock()
\brief Add a lock request and block on it until we get it. \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 \retval false Failed to acquire the lock. Most probable cause is that the
object is deleted. This frees the semaphore and releases the object is deleted. This frees the semaphore and releases the
pending Lock() requests. pending Lock() requests.
@@ -158,6 +165,7 @@ Flower::Water(int amount)
\see LockWithTimeout(bigtime_t timeout), Unlock() \see LockWithTimeout(bigtime_t timeout), Unlock()
*/ */
/*! /*!
\fn status_t BLocker::LockWithTimeout(bigtime_t timeout) \fn status_t BLocker::LockWithTimeout(bigtime_t timeout)
\brief Add a lock request and block until we get it or until it times out. \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() \see Lock(), Unlock()
*/ */
/*! /*!
\fn void BLocker::Unlock(void) \fn void BLocker::Unlock(void)
\brief Release the lock that's currently held. \brief Release the lock that's currently held.
*/ */
/*! /*!
\fn thread_id BLocker::LockingThread(void) const \fn thread_id BLocker::LockingThread(void) const
\brief Return the \c thread_id of the thread that's currently holding the \brief Return the \c thread_id of the thread that's currently holding the
lock. lock.
*/ */
/*! /*!
\fn bool BLocker::IsLocked(void) const \fn bool BLocker::IsLocked(void) const
\brief Check if the calling thread is actually holding the lock. \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. \retval false The object is unlocked or the lock is held by another thread.
*/ */
/*! /*!
\fn int32 BLocker::CountLocks(void) const \fn int32 BLocker::CountLocks(void) const
\brief Return the number of recursive locks that are currently held. \brief Return the number of recursive locks that are currently held.
*/ */
/*! /*!
\fn nt32 BLocker::CountLockRequests(void) const \fn nt32 BLocker::CountLockRequests(void) const
\brief Return the number of threads with a pending lock request. \brief Return the number of threads with a pending lock request.
*/ */
/*! /*!
\fn sem_id BLocker::Sem(void) const \fn sem_id BLocker::Sem(void) const
\brief Return the sem_id of the semaphore this object holds. \brief Return the sem_id of the semaphore this object holds.
+1 -1
View File
@@ -24,7 +24,7 @@
/*! /*!
\class BString String.h \class BString String.h
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief String class supporting common string operations. \brief String class supporting common string operations.
BString is a string allocation and manipulation class. The object BString is a string allocation and manipulation class. The object
+1 -1
View File
@@ -13,7 +13,7 @@
/*! /*!
\file SupportDefs.h \file SupportDefs.h
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief Defines basic types and definitions for the Haiku API. \brief Defines basic types and definitions for the Haiku API.
*/ */
+1 -1
View File
@@ -23,7 +23,7 @@
/*! /*!
\class BUnarchiver \class BUnarchiver
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief A class that simplifies the unarchiving of complicated BArchivable \brief A class that simplifies the unarchiving of complicated BArchivable
hierarchies. hierarchies.
+1 -1
View File
@@ -22,7 +22,7 @@
/*! /*!
\class BStopWatch \class BStopWatch
\ingroup support \ingroup support
\ingroup libbe \ingroup libroot
\brief A timer class. \brief A timer class.
This class provides method to time events. The interface is designed to This class provides method to time events. The interface is designed to