Changeset d34657e in mainline for src/lib/func.c

Timestamp:

2005-05-11T17:00:13Z (20 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

File:

• src/lib/func.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)