diff --git a/docs/user/support/Archivable.dox b/docs/user/support/Archivable.dox index 2a7a328bd3..7b388b492f 100644 --- a/docs/user/support/Archivable.dox +++ b/docs/user/support/Archivable.dox @@ -12,7 +12,7 @@ * * Corresponds to: * headers/os/support/Archivable.h rev 37751 - * src/kits/support/Archivable.cpp rev 37751 + * src/kits/support/Archivable.cpp rev 44303 */ diff --git a/docs/user/support/Archiver.dox b/docs/user/support/Archiver.dox index 0c2532b5d5..187fb4bc3f 100644 --- a/docs/user/support/Archiver.dox +++ b/docs/user/support/Archiver.dox @@ -7,7 +7,7 @@ * * Corresponds to: * headers/os/support/Archivable.h rev 37751 - * src/kits/support/Archivable.cpp rev 37751 + * src/kits/support/Archivable.cpp rev 44303 */ diff --git a/docs/user/support/Autolock.dox b/docs/user/support/Autolock.dox index ad6e27f59d..fb7f3c63a3 100644 --- a/docs/user/support/Autolock.dox +++ b/docs/user/support/Autolock.dox @@ -1,12 +1,12 @@ /* - * Copyright 2007 Haiku, Inc. All rights reserved. + * Copyright 2007-2013 Haiku, Inc. All rights reserved. * Distributed under the terms of the MIT License. * * Authors: * Niels Sascha Reedijk, niels.reedijk@gmail.com * * Corresponds to: - * headers/os/support/Autolock.h rev 19972 + * headers/os/support/Autolock.h rev 33370 */ @@ -28,14 +28,14 @@ of your code. This class is usually used in combination with a BLocker that protects a certain part of your code and data that are being accessed by multiple threads. While BAutolock does not add any features - to locking, it provides a mechanism to easily lock and protect a part of your - code. + to locking, it provides a mechanism to easily lock and protect a part of + your code. Normally, when you need to protect data, you would have to make sure that all your locks are paired with unlocks. Below is a simple example, but you can imagine that there are more complex situations where you might spend a - lot of time debugging a hang because you didn't pair all the Lock()s with an - Unlock(). See the example: + lot of time debugging a hang because you didn't pair all the Lock()s with + an Unlock(). See the example: \code status_t @@ -105,7 +105,7 @@ Receiver::HandleCall(Call *call) /*! - \fn bool BAutolock::IsLocked(void) + \fn bool BAutolock::IsLocked() \brief Verify whether the associated BLocker or BLooper are actually locked. @@ -119,3 +119,24 @@ Receiver::HandleCall(Call *call) \retval true The lock was acquired. \retval false Failed to acquire the lock. */ + + +/*! + \fn bool BAutolock::Lock() + \brief Lock the BAutolock if it has not already happened + + Note that unlike BLocker, the object is not locked with lock count. That + means that if the lock is already taken, this method returns \c true + without any action. + + \retval true The lock was acquired (or had already been acquired). + \retval false Failed to acquire the lock. +*/ + + +/*! + \fn void BAutolock::Unlock() + \brief Unlock the BAutolock if the lock is being held + + If the lock is not held, the method does nothing. +*/ \ No newline at end of file diff --git a/docs/user/support/Beep.dox b/docs/user/support/Beep.dox index fa5124cbfa..95a629fb5f 100644 --- a/docs/user/support/Beep.dox +++ b/docs/user/support/Beep.dox @@ -7,7 +7,7 @@ * * Corresponds to: * headers/os/support/Beep.h rev 19972 - * src/kits/support/Beep.cpp rev 20711 + * src/kits/support/Beep.cpp rev 34602 */ diff --git a/docs/user/support/BlockCache.dox b/docs/user/support/BlockCache.dox index 9b28e97e5c..a474542364 100644 --- a/docs/user/support/BlockCache.dox +++ b/docs/user/support/BlockCache.dox @@ -11,7 +11,7 @@ * * Corresponds to: * headers/os/support/BlockCache.h rev 19972 - * src/kits/support/BlockCache.cpp rev 4568 + * src/kits/support/BlockCache.cpp rev 43545 */ diff --git a/docs/user/support/BufferIO.dox b/docs/user/support/BufferIO.dox index 2f1c973e81..ff03d222ed 100644 --- a/docs/user/support/BufferIO.dox +++ b/docs/user/support/BufferIO.dox @@ -7,8 +7,8 @@ * Niels Sascha Reedijk, niels.reedijk@gmail.com * * Corresponds to: - * headers/os/support/BufferIO.h rev 19972 - * src/kits/support/BufferIO.cpp rev 20510 + * headers/os/support/BufferIO.h rev 38225 + * src/kits/support/BufferIO.cpp rev 44862 */ diff --git a/docs/user/support/DataIO.dox b/docs/user/support/DataIO.dox index bc6e61c2aa..f4b0b6c0b0 100644 --- a/docs/user/support/DataIO.dox +++ b/docs/user/support/DataIO.dox @@ -7,8 +7,8 @@ * Niels Sascha Reedijk, niels.reedijk@gmail.com * * Corresponds to: - * headers/os/support/DataIO.h rev 17981 - * src/kits/support/DataIO.cpp rev 20510 + * headers/os/support/DataIO.h rev 38226 + * src/kits/support/DataIO.cpp rev 42177 */ @@ -95,18 +95,18 @@ The interface of this object applies to objects or data that allows position-aware reading and writing of data. Classes that derive from this - class should at least re-implement ReadAt(), WriteAt(), Seek(), Position(), - SetSize() and GetSize() methods. + class should at least re-implement ReadAt(), WriteAt(), Seek(), + Position(), SetSize() and GetSize() methods. - A good example of a form of data that can derive from this object, are files. - The BFile class derives from BPositionIO and provides this interface to - files. If your object or data only supports linear reading and writing, - consider deriving from the base-class BDataIO. + A good example of a form of data that can derive from this object, are + files. The BFile class derives from BPositionIO and provides this + interface to files. If your object or data only supports linear reading + and writing, consider deriving from the base-class BDataIO. A final note, from BDataIO this class inherits Read() and Write(). The - default implementation is to read or write the data at the current position - indicated by Position(). Re-implement the methods if you require a different - behavior. + default implementation is to read or write the data at the current + position indicated by Position(). Re-implement the methods if you require + a different behavior. */ diff --git a/docs/user/support/Flattenable.dox b/docs/user/support/Flattenable.dox index eaa4ba5b09..94d1026ada 100644 --- a/docs/user/support/Flattenable.dox +++ b/docs/user/support/Flattenable.dox @@ -6,7 +6,7 @@ * Niels Sascha Reedijk * * Corresponds to: - * headers/os/support/Flattenable.h rev 19972 + * headers/os/support/Flattenable.h rev 39675 * src/kits/support/Flattenable.cpp rev 12963 */ diff --git a/docs/user/support/List.dox b/docs/user/support/List.dox index 2773cb411b..b545e70cd2 100644 --- a/docs/user/support/List.dox +++ b/docs/user/support/List.dox @@ -11,8 +11,8 @@ * John Drinkwater, jdrinkwater@gmail.com * * Corresponds to: - * headers/os/support/List.h rev 19972 - * src/kits/support/List.cpp rev 18649 + * headers/os/support/List.h rev 34520 + * src/kits/support/List.cpp rev 34520 */ diff --git a/docs/user/support/Locker.dox b/docs/user/support/Locker.dox index 25575bd8aa..06076829b5 100644 --- a/docs/user/support/Locker.dox +++ b/docs/user/support/Locker.dox @@ -1,13 +1,13 @@ /* - * Copyright 2007 Haiku, Inc. All rights reserved. + * Copyright 2007-2013 Haiku, Inc. All rights reserved. * Distributed under the terms of the MIT License. * * Authors: * Niels Sascha Reedijk, niels.reedijk@gmail.com * * Corresponds to: - * headers/os/support/Locker.h rev 19972 - * src/kits/support/Locker.cpp rev 13826 + * headers/os/support/Locker.h rev 36218 + * src/kits/support/Locker.cpp rev 32758 */ /*! @@ -153,6 +153,16 @@ Flower::Water(int amount) */ +/*! + \fn status_t BLocker::InitCheck() + \brief Check whether the locker has properly initialized + + \retval B_OK The semaphore has been properly initialized + \retval (negative) Any other error value that is related to semaphore + initialization +*/ + + /*! \fn bool BLocker::Lock() \brief Add a lock request and block on it until we get it. diff --git a/docs/user/support/typeconstants.dox b/docs/user/support/TypeConstants.dox similarity index 98% rename from docs/user/support/typeconstants.dox rename to docs/user/support/TypeConstants.dox index 04a15b74c6..8a1d7fcbd9 100644 --- a/docs/user/support/typeconstants.dox +++ b/docs/user/support/TypeConstants.dox @@ -6,7 +6,7 @@ * Niels Sascha Reedijk, niels.reedijk@gmail.com * * Corresponds to: - * headers/os/support/TypeConstants.h rev 20212 + * headers/os/support/TypeConstants.h rev 43506 */