Documentation fixes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@930 35acf78f-673a-0410-8e92-d51de3d6d3f4
master
gdisirio 2009-05-01 18:55:54 +00:00
parent 521443e167
commit 5557c78ea3
2 changed files with 6 additions and 4 deletions

View File

@ -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. * @return The removed thread pointer.
* @note This function is @b not an API. * @note This function is @b not an API.
*/ */

View File

@ -34,7 +34,7 @@ typedef struct Thread Thread;
#define notempty(p) ((p)->p_next != (Thread *)(p)) #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 * @extends ThreadsList
*/ */
typedef struct { typedef struct {
@ -45,7 +45,7 @@ typedef struct {
} ThreadsQueue; } ThreadsQueue;
/** /**
* @brief Generic threads single link list. * @brief Generic threads single linked list.
* @details This list behaves like a stack. * @details This list behaves like a stack.
*/ */
typedef struct { typedef struct {