Changeset abbc16e in mainline for generic/src

Timestamp:

2006-06-16T11:17:54Z (19 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

62939f7

Parents:

b6529ae

Message:

Fix some broken doxygen comments.

Location:

generic/src

Files:

• adt/btree.c (modified) (3 diffs)
• adt/hash_table.c (modified) (1 diff)
• console/console.c (modified) (1 diff)
• console/kconsole.c (modified) (1 diff)
• ddi/ddi.c (modified) (1 diff)
• ipc/ipc.c (modified) (1 diff)
• lib/func.c (modified) (1 diff)
• mm/buddy.c (modified) (1 diff)
• mm/frame.c (modified) (3 diffs)
• proc/scheduler.c (modified) (1 diff)
• syscall/copy.c (modified) (1 diff)

generic/src/adt/btree.c

@@ -215 +215 @@
 /** Remove B-tree node.
  *
- * @param B-tree.
+ * @param t B-tree.
  * @param key Key to be removed from the B-tree along with its associated value.
  * @param leaf_node If not NULL, pointer to the leaf node where the key is found.
@@ -235 +235 @@
 /** Recursively remove B-tree node.
  *
- * @param B-tree.
+ * @param t B-tree.
  * @param key Key to be removed from the B-tree along with its associated value.
  * @param node Node where the key being removed resides.
@@ -903 +903 @@
 /** Rotate in a key from the right sibling or from the index node, if this operation can be done.
  *
- * @param rnode Node into which to add key from its right sibling or from the index node.
+ * @param lnode Node into which to add key from its right sibling or from the index node.
  *
  * @return True if the rotation was performed, false otherwise.

generic/src/adt/hash_table.c

@@ -78 +78 @@
  *
  * @param h Hash table.
- * @param hey Array of all keys necessary to compute hash index.
+ * @param key Array of all keys necessary to compute hash index.
  * @param item Item to be inserted into the hash table.
  */

generic/src/console/console.c

@@ -118 +118 @@
  * @param chardev Character device.
  * @param buf Buffer where to store string terminated by '\0'.
- * @param len Size of the buffer.
+ * @param buflen Size of the buffer.
  *
  * @return Number of characters read.

generic/src/console/kconsole.c

@@ -404 +404 @@
 /** Kernel console managing thread.
  *
- * @param arg Not used.
+ * @param prompt Kernel console prompt (e.g kconsole/panic).
  */
 void kconsole(void *prompt)

generic/src/ddi/ddi.c

@@ -169 +169 @@
 /** Wrapper for SYS_ENABLE_IOSPACE syscall.
  *
- * @param User space address of DDI argument structure.
+ * @param uspace_io_arg User space address of DDI argument structure.
  *
  * @return 0 on success, otherwise it returns error code found in errno.h

generic/src/ipc/ipc.c

@@ -210 +210 @@
 /** Send a asynchronous request using phone to answerbox
  *
- * @param phone Phone connected to answerbox
- * @param request Request to be sent
+ * @param phone Phone connected to answerbox.
+ * @param call Structure representing the call.
  */
 int ipc_call(phone_t *phone, call_t *call)

generic/src/lib/func.c

@@ -136 +136 @@
  *
  * @param src Source string.
- * @param dst Destination buffer.
+ * @param dest Destination buffer.
  * @param len Size of destination buffer.
  */

generic/src/mm/buddy.c

@@ -287 +287 @@
  *
  * @param b Pointer to buddy system
- * @param es Element size
+ * @param elem_size Element size
  */
 void buddy_system_structure_print(buddy_system_t *b, size_t elem_size) {

generic/src/mm/frame.c

@@ -996 +996 @@
  * If it drops to zero, move the frame structure to free list.
  *
- * @param frame Frame number to be freed.
+ * @param pfn Frame number of the frame to be freed.
  */
 void frame_free(pfn_t pfn)
@@ -1022 +1022 @@
  * increment frame reference count.
  *
- * @param frame Frame no to be freed.
+ * @param pfn Frame number of the frame to be freed.
  */
 void frame_reference_add(pfn_t pfn)
@@ -1113 +1113 @@
 }
 
-/** Prints zone details
- *
- * @param base Zone base address OR zone number
+/** Prints zone details.
+ *
+ * @param num Zone base address or zone number.
  */
 void zone_print_one(int num) {

generic/src/proc/scheduler.c

@@ -254 +254 @@
  * When the function decides to relink rq's, it reconnects
  * respective pointers so that in result threads with 'pri'
- * greater or equal @start are moved to a higher-priority queue.
+ * greater or equal start are moved to a higher-priority queue.
  *
  * @param start Threshold priority.

generic/src/syscall/copy.c

@@ -95 +95 @@
  *
  * @param uspace_dst Destination userspace address.
- * @param uspace_src Source kernel address.
+ * @param src Source kernel address.
  * @param size Size of the data to be copied.
  *