Changes in uspace/app/sbi/src/os/posix.c [074444f:38aaacc2] in mainline

File:

• uspace/app/sbi/src/os/posix.c (modified) (8 diffs)

uspace/app/sbi/src/os/posix.c

@@ -47 +47 @@
  * The string functions are in fact standard C, but would not work under
  * HelenOS.
- */
-
-/** Concatenate two strings. */
+ * 
+ * XXX String functions used here only work with 8-bit text encoding.
+ */
+
+/** Concatenate two strings.
+ *
+ * @param a     First string
+ * @param b     Second string
+ * @return      New string, concatenation of @a a and @a b.
+ */
 char *os_str_acat(const char *a, const char *b)
 {
@@ -71 +78 @@
 }
 
-/** Compare two strings. */
+/** Compare two strings.
+ *
+ * @param a     First string
+ * @param b     Second string
+ * @return      Zero if equal, nonzero if not equal
+ */
 int os_str_cmp(const char *a, const char *b)
 {
@@ -77 +89 @@
 }
 
-/** Return number of characters in string. */
+/** Return number of characters in string.
+ *
+ * @param str   String
+ * @return      Number of characters in @a str.
+ */
 size_t os_str_length(const char *str)
 {
@@ -83 +99 @@
 }
 
-/** Duplicate string. */
+/** Duplicate string.
+ *
+ * @param str   String
+ * @return      New string, duplicate of @a str.
+ */
 char *os_str_dup(const char *str)
 {
@@ -89 +109 @@
 }
 
-/** Get character from string at the given index. */
+/** Get character from string at the given index.
+ *
+ * @param str           String
+ * @param index         Character index (starting from zero).
+ * @param out_char      Place to store character.
+ * @return              EOK on success, EINVAL if index is out of bounds,
+ *                      EIO on decoding error.
+ */
 int os_str_get_char(const char *str, int index, int *out_char)
 {
@@ -111 +138 @@
 }
 
-/** Read one line of input from the user. */
+/** Read one line of input from the user.
+ *
+ * @param ptr   Place to store pointer to new string.
+ */
 int os_input_line(char **ptr)
 {
@@ -126 +156 @@
 }
 
-/** Simple command execution. */
+/** Simple command execution.
+ *
+ * @param cmd   Command and arguments (NULL-terminated list of strings.)
+ *              Command is present just one, not duplicated.
+ */
 int os_exec(char *const cmd[])
 {
@@ -157 +191 @@
 }
 
-/** Store the executable file path via which we were executed. */
+/** Store the executable file path via which we were executed.
+ *
+ * @param path  Executable path via which we were executed.
+ */
 void os_store_ef_path(char *path)
 {