From 840eb5253736c02b9b894b519be90586f915f8ce Mon Sep 17 00:00:00 2001 From: gdisirio Date: Thu, 13 Dec 2012 08:04:25 +0000 Subject: Various documentation fixes. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@4911 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/kernel/include/chthreads.h | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/os/kernel/include/chthreads.h b/os/kernel/include/chthreads.h index 91b8b2fdf..eb55dae94 100644 --- a/os/kernel/include/chthreads.h +++ b/os/kernel/include/chthreads.h @@ -227,15 +227,17 @@ typedef msg_t (*tfunc_t)(void *); */ /** * @brief Returns a pointer to the current @p Thread. + * @note Can be invoked in any context. * - * @api + * @special */ #define chThdSelf() currp /** * @brief Returns the current thread priority. + * @note Can be invoked in any context. * - * @api + * @special */ #define chThdGetPriority() (currp->p_prio) @@ -243,34 +245,37 @@ typedef msg_t (*tfunc_t)(void *); * @brief Returns the number of ticks consumed by the specified thread. * @note This function is only available when the * @p CH_DBG_THREADS_PROFILING configuration option is enabled. + * @note Can be invoked in any context. * * @param[in] tp pointer to the thread * - * @api + * @special */ #define chThdGetTicks(tp) ((tp)->p_time) /** * @brief Returns the pointer to the @p Thread local storage area, if any. + * @note Can be invoked in any context. * - * @api + * @special */ #define chThdLS() (void *)(currp + 1) /** * @brief Verifies if the specified thread is in the @p THD_STATE_FINAL state. + * @note Can be invoked in any context. * * @param[in] tp pointer to the thread * @retval TRUE thread terminated. * @retval FALSE thread not terminated. * - * @api + * @special */ #define chThdTerminated(tp) ((tp)->p_state == THD_STATE_FINAL) /** * @brief Verifies if the current thread has a termination request pending. - * @note This function can be called in any context. + * @note Can be invoked in any context. * * @retval TRUE termination request pending. * @retval FALSE termination request not pending. -- cgit v1.2.3