Update Support Kit docs, add \since

Also add preliminary documentation for BObjectList.
This commit is contained in:
John Scipione
2014-06-24 19:30:54 -04:00
parent 29e8fa5922
commit c4b9309a99
17 changed files with 2695 additions and 1080 deletions
+87 -37
View File
@@ -1,9 +1,10 @@
/*
* Copyright 2007 Haiku, Inc. All rights reserved.
* Copyright 2007-2014 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
* Niels Sascha Reedijk, [email protected]
* John Scipione, [email protected]
*
* Corresponds to:
* headers/os/support/SupportDefs.h rev 35018
@@ -202,13 +203,17 @@
/*!
\typedef typedef int32 status_t
\brief Represents one of the status codes defined in Error.h
\brief Represents one of the status codes defined in Error.h.
\since BeOS R3
*/
/*!
\typedef typedef int64 bigtime_t
\brief Represents time. The unit depends on the context of the function.
\since BeOS R3
*/
@@ -221,7 +226,9 @@
/*!
\typedef typedef uint32 type_code
\brief Represents a certain type of data. See TypeConstants.h for
possible values.
possible values.
\since Haiku R1
*/
@@ -230,11 +237,13 @@
\brief Defined to support 'hidden' commands or extensions to classes.
The Haiku API has none of these.
\since Haiku R1
*/
//! @}
/*!
\name Format strings for printf() and scanf()
@@ -547,7 +556,7 @@
*/
/*!
/*!
\def B_PRIdDEV
\brief dev_t
*/
@@ -571,7 +580,7 @@
*/
/*!
/*!
\def B_PRIdTIME
\brief time_t
*/
@@ -588,10 +597,12 @@
//////////////// Odds and ends
/*!
\var const char *B_EMPTY_STRING
\var const char* B_EMPTY_STRING
\brief Defines an empty string. Currently defined as the string "".
\since BeOS R3
*/
@@ -599,8 +610,10 @@
\def min_c(a,b)
\brief Returns the minimum of the values a and b.
\note When including this header in a C file, use the C equivalent called
\c min(a,b).
\note When including this header in a C file, use the C equivalent called
\c min(a,b).
\since Haiku R1
*/
@@ -608,14 +621,18 @@
\def max_c(a,b)
\brief Returns the maximum of values a and b.
\note When including this header in a C file, use the C equivalent called
\c max(a,b).
\note When including this header in a C file, use the C equivalent called
\c max(a,b).
\since Haiku R1
*/
/*!
\def NULL
\brief Defines the constant \c NULL if it hasn't already been defined.
\since BeOS R3
*/
@@ -627,7 +644,8 @@
//! @{
/*! \fn void atomic_set(int32* value, int32 newValue)
/*!
\fn void atomic_set(int32* value, int32 newValue)
\brief Atomically set the variable \a value to \a newvalue.
This is a thread-safe way of performing the \c *value \c = \c newValue
@@ -641,17 +659,19 @@
\sa atomic_and()
\sa atomic_or(),
\sa atomic_get()
\since Haiku R1
*/
/*! \fn int32 atomic_get_and_set(int32* value, int32 newValue)
\brief Atomically set the variable \a value to \a newvalue and return the
old value.
old value.
This is a thread-safe way of performing the \c *value \c = \c newValue
operation. You should use these function when two or more threads might
access the variable simultaneously. You don't have to use a semaphore or a
mutex in this case.
mutex in this case.
\return The original value of \c value.
@@ -662,18 +682,20 @@
\sa atomic_and()
\sa atomic_or(),
\sa atomic_get()
\since Haiku R1
*/
/*! \fn int32 atomic_test_and_set(int32* value, int32 newValue,
int32 testAgainst)
\brief Atomically set the variable \a value to \a newValue if the current
value is \a testAgainst.
This is a thread-safe way of conditionally performing the \c *value \c +=
value is \a testAgainst.
This is a thread-safe way of conditionally performing the \c *value \c +=
\c newValue operation. You should use these function when two or more
threads might access the variable simultaneously. You don't have to use
a semaphore or a mutex in this case.
a semaphore or a mutex in this case.
\return The original value of \c value.
@@ -684,6 +706,8 @@
\sa atomic_and()
\sa atomic_or()
\sa atomic_get()
\since Haiku R1
*/
@@ -694,7 +718,7 @@
This is a thread-safe way of performing the \c *value \c += \c addValue
operation. You should use these function when two or more threads might
access the variable simultaneously. You don't have to use a semaphore or a
mutex in this case.
mutex in this case.
\return The original value of \c value.
@@ -705,17 +729,19 @@
\sa atomic_and()
\sa atomic_or()
\sa atomic_get()
\since BeOS R3
*/
/*! \fn int32 atomic_and(int32* value, int32 andValue)
\brief Atomically perform a bitwise AND operation of \a andValue to the
\brief Atomically perform a bitwise AND operation of \a andValue to the
variable \a andValue.
This is a thread-safe way of performing the \c *value \c &= \c andValue
operation. You should use these function when two or more threads might
access the variable simultaneously. You don't have to use a semaphore or a
mutex in this case.
mutex in this case.
\return The original value of \c value.
@@ -726,19 +752,20 @@
\sa atomic_add()
\sa atomic_or()
\sa atomic_get()
*/
\since BeOS R3
*/
/*!
\fn int32 atomic_or(int32* value, int32 orValue)
\brief Atomically perform a bitwise OR operation of \a orValue to the
variable \a andValue.
\brief Atomically perform a bitwise OR operation of \a orValue to the
variable \a andValue.
This is a thread-safe way of performing the \c *value \c |= \c orValue
operation. You should use these function when two or more threads might
access the variable simultaneously. You don't have to use a semaphore or a
mutex in this case.
mutex in this case.
\return The original value of \c value.
@@ -749,6 +776,8 @@
\sa atomic_add()
\sa atomic_and()
\sa atomic_get()
\since BeOS R3
*/
@@ -770,6 +799,8 @@
\sa atomic_add()
\sa atomic_and()
\sa atomic_or()
\since Haiku R1
*/
@@ -789,18 +820,20 @@
\sa atomic_and64()
\sa atomic_or64()
\sa atomic_get64()
\since Haiku R1
*/
/*!
\fn int64 atomic_get_and_set64(int64* value, int64 newValue)
\brief Atomically set the variable \a value to \a newvalue and return
the old value.
the old value.
This is a thread-safe way of performing the \c *value \c = \c newValue
operation. You should use these function when two or more threads might
access the variable simultaneously. You don't have to use a semaphore or a
mutex in this case.
mutex in this case.
\return The original value of \c value.
@@ -811,6 +844,8 @@
\sa atomic_and64()
\sa atomic_or64()
\sa atomic_get64()
\since Haiku R1
*/
@@ -818,12 +853,12 @@
\fn int64 atomic_test_and_set64(int64* value, int64 newValue,
int64 testAgainst)
\brief Atomically set the variable \a value to \a newValue if the current
value is \a testAgainst.
value is \a testAgainst.
This is a thread-safe way of conditionally performing the \c *value
\c += \c newValue operation. You should use these function when two
or more threads might access the variable simultaneously. You don't
have to use a semaphore or a mutex in this case.
have to use a semaphore or a mutex in this case.
\return The original value of \c value.
@@ -834,6 +869,8 @@
\sa atomic_and64()
\sa atomic_or64()
\sa atomic_get64()
\since Haiku R1
*/
@@ -844,8 +881,8 @@
This is a thread-safe way of performing the \c *value \c += \c addValue
operation. You should use these function when two or more threads might
access the variable simultaneously. You don't have to use a semaphore or a
mutex in this case.
mutex in this case.
\return The original value of \c value.
\sa atomic_add() for a version that works on an \c int32.
@@ -855,13 +892,15 @@
\sa atomic_and64()
\sa atomic_or64()
\sa atomic_get64()
\since Haiku R1
*/
/*!
\fn int64 atomic_and64(int64* value, int64 andValue)
\brief Atomically perform a bitwise AND operation of \a andValue to the
variable \a andValue.
variable \a andValue.
This is a thread-safe way of performing the \c *value \c &= \c andValue
operation. You should use these function when two or more threads might
@@ -877,17 +916,20 @@
\sa atomic_add64()
\sa atomic_or64()
\sa atomic_get64()
\since Haiku R1
*/
/*! \fn int64 atomic_or64(int64* value, int64 orValue)
/*!
\fn int64 atomic_or64(int64* value, int64 orValue)
\brief Atomically perform a bitwise OR operation of \a orValue to the
variable \a andValue.
variable \a andValue.
This is a thread-safe way of performing the \c *value \c |= \c orValue
operation. You should use these function when two or more threads might
access the variable simultaneously. You don't have to use a semaphore or a
mutex in this case.
mutex in this case.
\return The original value of \c value.
@@ -898,6 +940,8 @@
\sa atomic_add64()
\sa atomic_and64()
\sa atomic_get64()
\since Haiku R1
*/
@@ -919,6 +963,8 @@
\sa atomic_add64()
\sa atomic_and64()
\sa atomic_or64()
\since Haiku R1
*/
@@ -943,12 +989,16 @@
/*!
\def FALSE
\brief Obsolete. Use \c false.
\since BeOS R3
*/
/*!
\def TRUE
\brief Obsolete. Use \c true.
\since BeOS R3
*/