aboutsummaryrefslogtreecommitdiffstats
path: root/src/chlists.c
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-05-01 18:55:54 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-05-01 18:55:54 +0000
commit5557c78ea373a8520b5ca75c687152e973216dd1 (patch)
tree21da8bb3460a958fdfe81a8ebf82c0590610505e /src/chlists.c
parent521443e16740cdf9e550425cffbb4e6c53b98cfd (diff)
downloadChibiOS-5557c78ea373a8520b5ca75c687152e973216dd1.tar.gz
ChibiOS-5557c78ea373a8520b5ca75c687152e973216dd1.tar.bz2
ChibiOS-5557c78ea373a8520b5ca75c687152e973216dd1.zip
Documentation fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@930 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'src/chlists.c')
-rw-r--r--src/chlists.c6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/chlists.c b/src/chlists.c
index 24ceb4cc1..8d191fc12 100644
--- a/src/chlists.c
+++ b/src/chlists.c
@@ -92,9 +92,11 @@ Thread *lifo_remove(ThreadsQueue *tqp) {
}
/**
- * @brief Removes a Thread from a FIFO list and returns it.
+ * @brief Removes a Thread from a queue and returns it.
+ * @details The thread is removed from the queue regardless of its relative
+ * position and regardless the used insertion method.
*
- * @param[in] tp the pointer to the thread to be removed from the list
+ * @param[in] tp the pointer to the thread to be removed from the queue
* @return The removed thread pointer.
* @note This function is @b not an API.
*/