Documentation improvements.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@830 35acf78f-673a-0410-8e92-d51de3d6d3f4

1 files changed, 10 insertions, 10 deletions

diff --git a/src/chlists.c b/src/chlists.c
index 39bea02cc..a3ec568a0 100644
--- a/src/chlists.c
+++ b/src/chlists.c
@@ -29,8 +29,8 @@
 /**

  * @brief Inserts a thread into a priority ordered queue.

  *

- * @param tp the pointer to the thread to be inserted in the list

- * @param tqp the pointer to the threads list header

+ * @param[in] tp the pointer to the thread to be inserted in the list

+ * @param[in] tqp the pointer to the threads list header

  * @note The insertion is done by scanning the list from the highest priority

  *       toward the lowest.

  * @note This function is @b not an API.

@@ -52,8 +52,8 @@ void prio_insert(Thread *tp, ThreadsQueue *tqp) {
 /**

  * @brief Inserts a Thread into a queue.

  *

- * @param tp the pointer to the thread to be inserted in the list

- * @param tqp the pointer to the threads list header

+ * @param[in] tp the pointer to the thread to be inserted in the list

+ * @param[in] tqp the pointer to the threads list header

  * @note This function is @b not an API.

  */

 void queue_insert(Thread *tp, ThreadsQueue *tqp) {

@@ -65,7 +65,7 @@ void queue_insert(Thread *tp, ThreadsQueue *tqp) {
 /**

  * @brief Removes the first-out Thread from a queue and returns it.

  *

- * @param tqp the pointer to the threads list header

+ * @param[in] tqp the pointer to the threads list header

  * @return The removed thread pointer.

  * @note This function is @b not an API.

  */

@@ -79,7 +79,7 @@ Thread *fifo_remove(ThreadsQueue *tqp) {
 /**

  * @brief Removes the last-out Thread from a queue and returns it.

  *

- * @param tqp the pointer to the threads list header

+ * @param[in] tqp the pointer to the threads list header

  * @return The removed thread pointer.

  * @note This function is @b not an API.

  */

@@ -93,7 +93,7 @@ Thread *lifo_remove(ThreadsQueue *tqp) {
 /**

  * @brief Removes a Thread from a FIFO list and returns it.

  *

- * @param 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 list

  * @return The removed thread pointer.

  * @note This function is @b not an API.

  */

@@ -107,8 +107,8 @@ Thread *dequeue(Thread *tp) {
 /**

  * @brief Pushes a Thread on top of a stack list.

  *

- * @param tp the pointer to the thread to be inserted in the list

- * @param tlp the pointer to the threads list header

+ * @param[in] tp the pointer to the thread to be inserted in the list

+ * @param[in] tlp the pointer to the threads list header

  * @note This function is @b not an API.

  */

 void list_insert(Thread *tp, ThreadsList *tlp) {

@@ -120,7 +120,7 @@ void list_insert(Thread *tp, ThreadsList *tlp) {
 /**

  * @brief Pops a Thread from the top of a stack list and returns it.

  *

- * @param tlp the pointer to the threads list header

+ * @param[in] tlp the pointer to the threads list header

  * @return The removed thread pointer.

  * @note The list must be non-empty before calling this function.

  * @note This function is @b not an API.