Changeset d34657e in mainline

Timestamp:

2005-05-11T17:00:13Z (19 years ago)

Author:

Martin Decky <martin@…>

Branches:

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

Children:

27dc170

Parents:

724b58a

Message:

doxygen-style comments

Location:

src/lib

Files:

• func.c (modified) (2 diffs)
• list.c (modified) (2 diffs)
• memstr.c (modified) (2 diffs)

src/lib/func.c

@@ -33 +33 @@
 #include <arch.h>
 
-__u32   haltstate = 0;
+__u32   haltstate = 0; /**< Halt flag */
 
+
+/** Halt wrapper
+ *
+ * Set halt flag and halt the cpu.
+ *
+ */
 void halt(void)
 {
@@ -44 +50 @@
 
 
-/*
- * returns 0 if src == dst
- * otherwise returns 1
+/** Compare two NULL terminated strings
+ *
+ * Do a char-by-char comparment of two NULL terminated strings.
+ * The strings are considered equal iff they have the same
+ * length and consist of the same characters.
+ *
+ * @param src First string to compare.
+ * @param dst Second string to compare.
+ *
+ * @return 0 if the strings are equal, 1 otherwise.
+ *
  */
 int strcmp(char *src, char *dst)

src/lib/list.c

@@ -29 +29 @@
 #include <list.h>
 
+
+/** Check for membership
+ *
+ * Check whether link is contained in the list head.
+ * The membership is defined as pointer equivalence.
+ *
+ * @param link Item to look for.
+ * @param head List to look in.
+ *
+ * @return 1 if link is contained in head, 0 otherwise.
+ *
+ */
 int list_member(link_t *link, link_t *head)
 {
@@ -45 +57 @@
 }
 
+
+/** Concatenate two lists
+ *
+ * Concatenate lists head1 and head2, producing a single
+ * list head1 containing items from both (in head1, head2
+ * order) and empty list head2.
+ *
+ * @param head1 First list and concatenated output
+ * @param head2 Second list and empty output.
+ *
+ */
 void list_concat(link_t *head1, link_t *head2)
 {

src/lib/memstr.c

@@ -30 +30 @@
 #include <arch/types.h>
 
+
+/** Copy block of memory
+ *
+ * Copy cnt bytes from src address to dst address.
+ * The copying is done byte-by-byte. The source
+ * and destination memory areas cannot overlap.
+ *
+ * @param src Origin address to copy from.
+ * @param dst Origin address to copy to.
+ * @param cnt Number of bytes to copy.
+ *
+ */
 void _memcopy(__address src, __address dst, int cnt)
 {
@@ -38 +50 @@
 }
 
+
+/** Fill block of memory
+ *
+ * Fill cnt bytes at dst address with the value x.
+ * The filling is done byte-by-byte.
+ *
+ * @param dst Origin address to fill.
+ * @param cnt Number of bytes to fill.
+ * @param x   Value to fill.
+ *
+ */
 void _memsetb(__address dst, int cnt, __u8 x)
 {