summaryrefslogtreecommitdiffstats
path: root/cpukit/libfs/src/rfs/rtems-rfs-shell.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2013-01-08 09:02:58 -0500
committerGedare Bloom <gedare@rtems.org>2013-01-08 09:02:58 -0500
commite354eb4f4fbd602adede59138c819eb94e7c1488 (patch)
tree50a219aab9a9d69d1e53bf45f38ff15476dd0b0c /cpukit/libfs/src/rfs/rtems-rfs-shell.h
parentsapi: Doxygen Clean Up Task #1 (diff)
downloadrtems-e354eb4f4fbd602adede59138c819eb94e7c1488.tar.bz2
libfs: Doxygen Clean Up Task #1
http://www.google-melange.com/gci/task/view/google/gci2012/8120204 Patch committed with fixes for whitespace issues.
Diffstat (limited to 'cpukit/libfs/src/rfs/rtems-rfs-shell.h')
-rw-r--r--cpukit/libfs/src/rfs/rtems-rfs-shell.h17
1 files changed, 10 insertions, 7 deletions
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-shell.h b/cpukit/libfs/src/rfs/rtems-rfs-shell.h
index 135290d3e9..a917b8556c 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-shell.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-shell.h
@@ -1,6 +1,5 @@
/**
* @file
- *
*
* @ingroup rtems-rfs
* @brief RTEMS File Systems Shell Commands
@@ -27,18 +26,22 @@
/**
* The shell command for the RFS debugger.
*
- * @param argc The argument count.
- * @param argv The argument variables.
- * @return int The exit code for the command. A 0 is no error.
+ * @param[in] argc is the argument count.
+ * @param[in] argv is a pointer to the argument variables.
+ *
+ * @retval 0 Successful operation.
+ * @retval error_code An error occurred.
*/
int rtems_shell_debugrfs (int argc, char *argv[]);
/**
* The shell command for formatting an RFS file system.
*
- * @param argc The argument count.
- * @param argv The argument variables.
- * @return int The exit code for the command. A 0 is no error.
+ * @param[in] argc is the argument count.
+ * @param[in] argv is a pointer to the argument variables.
+ *
+ * @retval 0 Successful operation.
+ * @retval 1 An error occurred.
*/
int rtems_shell_rfs_format (int argc, char* argv[]);