mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2025-01-04 06:06:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

os: Improve docs for thread helper.

Browse source
This commit is contained in:
Ryan Pavlik 2021-10-15 11:57:44 -05:00
parent 2790f6d29f
commit 793a7d659d
1 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/xrt/auxiliary/os/os_threading.h
View file

@ -263,6 +263,8 @@ struct os_thread_helper
/*! /*!
* Initialize the thread helper. * Initialize the thread helper.
*
* @public @memberof os_thread_helper
*/ */
static inline int static inline int
os_thread_helper_init(struct os_thread_helper *oth) os_thread_helper_init(struct os_thread_helper *oth)
@ -283,6 +285,8 @@ os_thread_helper_init(struct os_thread_helper *oth)
/*! /*!
* Start the internal thread. * Start the internal thread.
*
* @public @memberof os_thread_helper
*/ */
static inline int static inline int
os_thread_helper_start(struct os_thread_helper *oth, os_run_func func, void *ptr) os_thread_helper_start(struct os_thread_helper *oth, os_run_func func, void *ptr)
@ -339,7 +343,9 @@ os_thread_helper_stop(struct os_thread_helper *oth)
} }
/*! /*!
* Destroy the thread helper, externally syncronizable. * Destroy the thread helper, externally synchronizable.
*
* @public @memberof os_thread_helper
*/ */
static inline void static inline void
os_thread_helper_destroy(struct os_thread_helper *oth) os_thread_helper_destroy(struct os_thread_helper *oth)
@ -354,6 +360,8 @@ os_thread_helper_destroy(struct os_thread_helper *oth)
/*! /*!
* Lock the helper. * Lock the helper.
*
* @public @memberof os_thread_helper
*/ */
static inline void static inline void
os_thread_helper_lock(struct os_thread_helper *oth) os_thread_helper_lock(struct os_thread_helper *oth)
@ -363,6 +371,8 @@ os_thread_helper_lock(struct os_thread_helper *oth)
/*! /*!
* Unlock the helper. * Unlock the helper.
*
* @public @memberof os_thread_helper
*/ */
static inline void static inline void
os_thread_helper_unlock(struct os_thread_helper *oth) os_thread_helper_unlock(struct os_thread_helper *oth)
@ -374,6 +384,8 @@ os_thread_helper_unlock(struct os_thread_helper *oth)
* Is the thread running, or supposed to be running. * Is the thread running, or supposed to be running.
* *
* Must be called with the helper locked. * Must be called with the helper locked.
*
* @public @memberof os_thread_helper
*/ */
static inline bool static inline bool
os_thread_helper_is_running_locked(struct os_thread_helper *oth) os_thread_helper_is_running_locked(struct os_thread_helper *oth)
@ -385,6 +397,8 @@ os_thread_helper_is_running_locked(struct os_thread_helper *oth)
* Wait for a signal. * Wait for a signal.
* *
* Must be called with the helper locked. * Must be called with the helper locked.
*
* @public @memberof os_thread_helper
*/ */
static inline void static inline void
os_thread_helper_wait_locked(struct os_thread_helper *oth) os_thread_helper_wait_locked(struct os_thread_helper *oth)
@ -396,6 +410,8 @@ os_thread_helper_wait_locked(struct os_thread_helper *oth)
* Signal a waiting thread to wake up. * Signal a waiting thread to wake up.
* *
* Must be called with the helper locked. * Must be called with the helper locked.
*
* @public @memberof os_thread_helper
*/ */
static inline void static inline void
os_thread_helper_signal_locked(struct os_thread_helper *oth) os_thread_helper_signal_locked(struct os_thread_helper *oth)