From 8fe4a7d9eb879664126d0d0a7aa5d49609ad955e Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Fri, 15 Aug 2025 20:50:02 -0500 Subject: [PATCH] Cleanup: Add missing documentation in certain thread functions. --- level_0/f_thread/c/thread/barrier.h | 12 ++++++++++++ level_0/f_thread/c/thread/condition.h | 12 ++++++++++++ level_0/f_thread/c/thread/lock.h | 4 ++++ level_0/f_thread/c/thread/mutex.h | 12 ++++++++++++ 4 files changed, 40 insertions(+) diff --git a/level_0/f_thread/c/thread/barrier.h b/level_0/f_thread/c/thread/barrier.h index 81d32c1..28ca272 100644 --- a/level_0/f_thread/c/thread/barrier.h +++ b/level_0/f_thread/c/thread/barrier.h @@ -70,12 +70,15 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a barrier is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_resize(). * * @see f_memory_array_resize() * @see f_memory_arrays_resize() + * + * @see pthread_barrier_destroy() */ #ifndef _di_f_thread_barriers_delete_callback_ extern f_status_t f_thread_barriers_delete_callback(const f_number_unsigned_t start, const f_number_unsigned_t stop, void * const array); @@ -100,12 +103,15 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a barrier is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_adjust(). * * @see f_memory_array_adjust() * @see f_memory_arrays_adjust() + * + * @see pthread_barrier_destroy() */ #ifndef _di_f_thread_barriers_destroy_callback_ extern f_status_t f_thread_barriers_destroy_callback(const f_number_unsigned_t start, const f_number_unsigned_t stop, void * const array); @@ -130,12 +136,15 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a barrier is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_resize(). * * @see f_memory_array_resize() * @see f_memory_arrays_resize() + * + * @see pthread_barrier_destroy() */ #ifndef _di_f_thread_barrierss_delete_callback_ extern f_status_t f_thread_barrierss_delete_callback(const f_number_unsigned_t start, const f_number_unsigned_t stop, void * const array); @@ -160,12 +169,15 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a barrier is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_adjust(). * * @see f_memory_array_adjust() * @see f_memory_arrays_adjust() + * + * @see pthread_barrier_destroy() */ #ifndef _di_f_thread_barrierss_destroy_callback_ extern f_status_t f_thread_barrierss_destroy_callback(const f_number_unsigned_t start, const f_number_unsigned_t stop, void * const array); diff --git a/level_0/f_thread/c/thread/condition.h b/level_0/f_thread/c/thread/condition.h index c63d687..4f6dcdd 100644 --- a/level_0/f_thread/c/thread/condition.h +++ b/level_0/f_thread/c/thread/condition.h @@ -71,12 +71,15 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a condition is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_resize(). * * @see f_memory_array_resize() * @see f_memory_arrays_resize() + * + * @see pthread_condition_destroy() */ #ifndef _di_f_thread_conditions_delete_callback_ extern f_status_t f_thread_conditions_delete_callback(const f_number_unsigned_t start, const f_number_unsigned_t stop, void * const array); @@ -101,12 +104,15 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a condition is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_adjust(). * * @see f_memory_array_adjust() * @see f_memory_arrays_adjust() + * + * @see pthread_condition_destroy() */ #ifndef _di_f_thread_conditions_destroy_callback_ extern f_status_t f_thread_conditions_destroy_callback(const f_number_unsigned_t start, const f_number_unsigned_t stop, void * const array); @@ -131,12 +137,15 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a condition is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_resize(). * * @see f_memory_array_resize() * @see f_memory_arrays_resize() + * + * @see pthread_condition_destroy() */ #ifndef _di_f_thread_conditionss_delete_callback_ extern f_status_t f_thread_conditionss_delete_callback(const f_number_unsigned_t start, const f_number_unsigned_t stop, void * const array); @@ -161,12 +170,15 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a condition is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_adjust(). * * @see f_memory_array_adjust() * @see f_memory_arrays_adjust() + * + * @see pthread_condition_destroy() */ #ifndef _di_f_thread_conditionss_destroy_callback_ extern f_status_t f_thread_conditionss_destroy_callback(const f_number_unsigned_t start, const f_number_unsigned_t stop, void * const array); diff --git a/level_0/f_thread/c/thread/lock.h b/level_0/f_thread/c/thread/lock.h index 73a3f11..02f8b2b 100644 --- a/level_0/f_thread/c/thread/lock.h +++ b/level_0/f_thread/c/thread/lock.h @@ -71,6 +71,7 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a lock is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_resize(). @@ -101,6 +102,7 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a lock is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_adjust(). @@ -131,6 +133,7 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a lock is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_resize(). @@ -161,6 +164,7 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a lock is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_adjust(). diff --git a/level_0/f_thread/c/thread/mutex.h b/level_0/f_thread/c/thread/mutex.h index 094a48c..06efdde 100644 --- a/level_0/f_thread/c/thread/mutex.h +++ b/level_0/f_thread/c/thread/mutex.h @@ -85,12 +85,15 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a mutex is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_resize(). * * @see f_memory_array_resize() * @see f_memory_arrays_resize() + * + * @see pthread_mutex_destroy() */ #ifndef _di_f_thread_mutexs_delete_callback_ extern f_status_t f_thread_mutexs_delete_callback(const f_number_unsigned_t start, const f_number_unsigned_t stop, void * const array); @@ -115,12 +118,15 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a mutex is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_adjust(). * * @see f_memory_array_adjust() * @see f_memory_arrays_adjust() + * + * @see pthread_mutex_destroy() */ #ifndef _di_f_thread_mutexs_destroy_callback_ extern f_status_t f_thread_mutexs_destroy_callback(const f_number_unsigned_t start, const f_number_unsigned_t stop, void * const array); @@ -145,12 +151,15 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a mutex is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_resize(). * * @see f_memory_array_resize() * @see f_memory_arrays_resize() + * + * @see pthread_mutex_destroy() */ #ifndef _di_f_thread_mutexss_delete_callback_ extern f_status_t f_thread_mutexss_delete_callback(const f_number_unsigned_t start, const f_number_unsigned_t stop, void * const array); @@ -175,12 +184,15 @@ extern "C" { * @return * F_okay on success. * + * F_busy (with error bit) if a mutex is busy. * F_parameter (with error bit) if a parameter is invalid. * * Errors (with error bit) from: f_memory_array_adjust(). * * @see f_memory_array_adjust() * @see f_memory_arrays_adjust() + * + * @see pthread_mutex_destroy() */ #ifndef _di_f_thread_mutexss_destroy_callback_ extern f_status_t f_thread_mutexss_destroy_callback(const f_number_unsigned_t start, const f_number_unsigned_t stop, void * const array); -- 1.8.3.1