diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-05-01 18:55:54 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-05-01 18:55:54 +0000 |
| commit | 5557c78ea373a8520b5ca75c687152e973216dd1 (patch) | |
| tree | 21da8bb3460a958fdfe81a8ebf82c0590610505e | |
| parent | 521443e16740cdf9e550425cffbb4e6c53b98cfd (diff) | |
| download | ChibiOS-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
| -rw-r--r-- | src/chlists.c | 6 | ||||
| -rw-r--r-- | src/include/lists.h | 4 |
2 files changed, 6 insertions, 4 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.
*/
diff --git a/src/include/lists.h b/src/include/lists.h index b858a7c69..89fdb84a7 100644 --- a/src/include/lists.h +++ b/src/include/lists.h @@ -34,7 +34,7 @@ typedef struct Thread Thread; #define notempty(p) ((p)->p_next != (Thread *)(p))
/**
- * @brief Generic threads queue header and element.
+ * @brief Generic threads bidirectional linked list header and element.
* @extends ThreadsList
*/
typedef struct {
@@ -45,7 +45,7 @@ typedef struct { } ThreadsQueue;
/**
- * @brief Generic threads single link list.
+ * @brief Generic threads single linked list.
* @details This list behaves like a stack.
*/
typedef struct {
|