Changeset 2a53f71 in mainline

Timestamp:

2011-07-31T04:59:20Z (14 years ago)

Author:

Petr Koupy <petr.koupy@…>

Branches:

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

Children:

27a8d1d

Parents:

11544f4

Message:

Added missing comments to the newly implemented functions.

Location:

uspace/lib/posix

Files:

• stdio.c (modified) (1 diff)
• stdlib.h (modified) (1 diff)
• sys/wait.c (modified) (2 diffs)
• unistd.c (modified) (5 diffs)
• unistd.h (modified) (1 diff)

uspace/lib/posix/stdio.c

@@ -726 +726 @@
  * Rename a file or directory.
  *
- * @param old
- * @param new
+ * @param old Old pathname.
+ * @param new New pathname.
  * @return Zero on success, -1 (with errno set) otherwise.
  */

uspace/lib/posix/stdlib.h

@@ -113 +113 @@
 extern void posix_free(void *ptr);
 
-/* Temporary files */
+/* Temporary Files */
 extern int posix_mkstemp(char *tmpl);
 

uspace/lib/posix/sys/wait.c

@@ -67 +67 @@
 
 /**
+ * Wait for any child process to stop or terminate.
  * 
- * @param stat_ptr
- * @return
+ * @param stat_ptr Location of the final status code of the child process.
+ * @return ID of the child process for which status is reported,
+ *     -1 on signal interrupt, (pid_t)-1 otherwise.
  */
 posix_pid_t posix_wait(int *stat_ptr)
@@ -79 +81 @@
 
 /**
+ * Wait for a child process to stop or terminate.
  * 
- * @param pid
- * @param stat_ptr
- * @param options
- * @return
+ * @param pid What child process shall the caller wait for. See POSIX manual
+ *     for details.
+ * @param stat_ptr Location of the final status code of the child process.
+ * @param options Constraints of the waiting. See POSIX manual for details.
+ * @return ID of the child process for which status is reported,
+ *     -1 on signal interrupt, 0 if non-blocking wait is requested but there is
+ *     no child process whose status can be reported, (pid_t)-1 otherwise.
  */
 posix_pid_t posix_waitpid(posix_pid_t pid, int *stat_ptr, int options)

uspace/lib/posix/unistd.c

@@ -186 +186 @@
  * Close a file.
  *
- * @param fildes
+ * @param fildes File descriptor of the opened file.
  * @return 0 on success, -1 on error.
  */
@@ -223 +223 @@
  * Requests outstanding data to be written to the underlying storage device.
  *
- * @param fildes
+ * @param fildes File descriptor of the opened file.
+ * @return Zero on success, -1 otherwise.
  */
 int posix_fsync(int fildes)
@@ -230 +231 @@
 }
 
+/**
+ * Truncate a file to a specified length.
+ *
+ * @param fildes File descriptor of the opened file.
+ * @param length New length of the file.
+ * @return Zero on success, -1 otherwise.
+ */
 int posix_ftruncate(int fildes, posix_off_t length)
 {
@@ -257 +265 @@
 }
 
+/**
+ * Duplicate an open file descriptor.
+ *
+ * @param fildes File descriptor to be duplicated.
+ * @return On success, new file descriptor for the same file, otherwise -1.
+ */
 int posix_dup(int fildes)
 {
@@ -262 +276 @@
 }
 
+/**
+ * Duplicate an open file descriptor.
+ * 
+ * @param fildes File descriptor to be duplicated.
+ * @param fildes2 File descriptor to be paired with the same file description
+ *     as is paired fildes.
+ * @return fildes2 on success, -1 otherwise.
+ */
 int posix_dup2(int fildes, int fildes2)
 {

uspace/lib/posix/unistd.h

@@ -72 +72 @@
 /* File Manipulation */
 extern int posix_close(int fildes);
-
 extern ssize_t posix_read(int fildes, void *buf, size_t nbyte);
 extern ssize_t posix_write(int fildes, const void *buf, size_t nbyte);
-
 extern int posix_fsync(int fildes);
 extern int posix_ftruncate(int fildes, posix_off_t length);
-
 extern int posix_rmdir(const char *path);
 extern int posix_unlink(const char *path);
-
 extern int posix_dup(int fildes);
 extern int posix_dup2(int fildes, int fildes2);