summaryrefslogtreecommitdiffstats
path: root/cpukit/libfs/src/dosfs/msdos.h
diff options
context:
space:
mode:
authorMathew Kallada <matkallada@gmail.com>2012-12-28 08:05:20 -0600
committerJennifer Averett <jennifer.averett@oarcorp.com>2012-12-28 08:05:20 -0600
commit4e592763cbeeb457260e029f906a4f3a1e70ed2f (patch)
treee2daf0e84086a316cd754bc1f51d53aaf8c46eea /cpukit/libfs/src/dosfs/msdos.h
parentlibfs: Doxygen Enhancement Task #3 (diff)
downloadrtems-4e592763cbeeb457260e029f906a4f3a1e70ed2f.tar.bz2
libfs: Doxygen Enhancement Task #5
Diffstat (limited to 'cpukit/libfs/src/dosfs/msdos.h')
-rw-r--r--cpukit/libfs/src/dosfs/msdos.h19
1 files changed, 12 insertions, 7 deletions
diff --git a/cpukit/libfs/src/dosfs/msdos.h b/cpukit/libfs/src/dosfs/msdos.h
index ad0841297c..d4f674317f 100644
--- a/cpukit/libfs/src/dosfs/msdos.h
+++ b/cpukit/libfs/src/dosfs/msdos.h
@@ -80,7 +80,7 @@ extern const rtems_filesystem_file_handlers_r msdos_file_handlers;
#define MSDOS_HARD_LINK RTEMS_FILESYSTEM_HARD_LINK /* pseudo type */
/**
- * @brief Type of Node that Loc Refers To
+ * @brief Type of node that loc refers to.
*
* The following returns the type of node that the loc refers to.
*
@@ -233,7 +233,7 @@ typedef enum msdos_token_types_e
#define MSDOS_DPS512_NUM 16
/**
- * @brief Shut Down MSDOS FileSystem
+ * @brief Shut down the MSDOS filesystem.
*
* MSDOS shut down handler implementation
*/
@@ -242,7 +242,7 @@ void msdos_shut_down(rtems_filesystem_mount_table_entry_t *temp_mt_entry);
void msdos_eval_path(rtems_filesystem_eval_path_context_t *ctx);
/**
- * @brief Call Fat-File Close Routine
+ * @brief Call the Fat-File close routine.
*
* Free node handler implementation for the filesystem operations table.
*/
@@ -252,6 +252,11 @@ rtems_filesystem_node_types_t msdos_node_type(
const rtems_filesystem_location_info_t *loc
);
+/**
+ * @brief Routine for node creation in a MSDOS filesystem.
+ *
+ * MSDOS Directory Handlers Implementation
+ */
int msdos_mknod(
const rtems_filesystem_location_info_t *loc,
const char *name,
@@ -261,7 +266,7 @@ int msdos_mknod(
);
/**
- * @brief Remove Node from MSDOS Directory
+ * @brief Remove node from MSDOS directory.
*
* MSDOS Directory Handlers Implementation
*/
@@ -271,7 +276,7 @@ int msdos_rmnod(
);
/**
- * @brief Rename a MSDOS FileSystem Node
+ * @brief rename a MSDOS filesystem node
*
* Routine to rename a MSDOS filesystem node
*/
@@ -288,7 +293,7 @@ void msdos_lock(const rtems_filesystem_mount_table_entry_t *mt_entry);
void msdos_unlock(const rtems_filesystem_mount_table_entry_t *mt_entry);
/**
- * @brief MSDOS Filesystem Initialization
+ * @brief The MSDOS filesystem initialization.
*
* MSDOS Initialization support routine implementation
*/
@@ -342,7 +347,7 @@ int msdos_dir_stat(
);
/**
- * @brief Implements wake up version of the "signal" operation
+ * @brief Implements wake up version of the "signal" operation.
*
* Routine to create a new MSDOS filesystem node
*