diff options
author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-18 15:46:38 -0500 |
---|---|---|
committer | Gedare Bloom <gedare@rtems.org> | 2012-12-18 15:46:38 -0500 |
commit | 11109ea227913904ae24b68ada25a9a18d73ec4c (patch) | |
tree | 8282b9742bf53758929a77a2575664b7e21221ad /cpukit/libfs/src/imfs | |
parent | d527562eee32b766b7aa3babeb50842b011bddb6 (diff) |
libfs: Doxygen Enhancement Task #2
http://www.google-melange.com/gci/task/view/google/gci2012/8032207
Diffstat (limited to 'cpukit/libfs/src/imfs')
-rw-r--r-- | cpukit/libfs/src/imfs/deviceio.c | 12 | ||||
-rw-r--r-- | cpukit/libfs/src/imfs/imfs.h | 79 | ||||
-rw-r--r-- | cpukit/libfs/src/imfs/imfs_creat.c | 14 | ||||
-rw-r--r-- | cpukit/libfs/src/imfs/imfs_eval.c | 9 | ||||
-rw-r--r-- | cpukit/libfs/src/imfs/imfs_fchmod.c | 9 | ||||
-rw-r--r-- | cpukit/libfs/src/imfs/imfs_initsupp.c | 9 | ||||
-rw-r--r-- | cpukit/libfs/src/imfs/imfs_mount.c | 9 | ||||
-rw-r--r-- | cpukit/libfs/src/imfs/imfs_ntype.c | 12 | ||||
-rw-r--r-- | cpukit/libfs/src/imfs/imfs_stat.c | 11 | ||||
-rw-r--r-- | cpukit/libfs/src/imfs/imfs_utime.c | 12 | ||||
-rw-r--r-- | cpukit/libfs/src/imfs/ioman.c | 16 |
11 files changed, 147 insertions, 45 deletions
diff --git a/cpukit/libfs/src/imfs/deviceio.c b/cpukit/libfs/src/imfs/deviceio.c index 679f94559c..094e92d2ef 100644 --- a/cpukit/libfs/src/imfs/deviceio.c +++ b/cpukit/libfs/src/imfs/deviceio.c @@ -1,9 +1,11 @@ -/* - * IMFS Device Node Handlers - * - * This file contains the set of handlers used to map operations on - * IMFS device nodes onto calls to the RTEMS Classic API IO Manager. +/** + * @file * + * @brief IMFS Device Node Handlers + * @ingroup IMFS + */ + +/* * COPYRIGHT (c) 1989-2012. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libfs/src/imfs/imfs.h b/cpukit/libfs/src/imfs/imfs.h index aed00778e7..6615b1b157 100644 --- a/cpukit/libfs/src/imfs/imfs.h +++ b/cpukit/libfs/src/imfs/imfs.h @@ -1,7 +1,7 @@ /** * @file rtems/imfs.h * - * Header file for the In-Memory File System + * @brief Header file for the In-Memory File System */ /* @@ -21,6 +21,12 @@ #include <rtems/libio_.h> #include <rtems/pipe.h> +/** + * @defgroup IMFS POSIX In-Memory File System Support + * + * @brief In-Memory File System Support + */ + #ifdef __cplusplus extern "C" { #endif @@ -158,6 +164,9 @@ typedef IMFS_jnode_t *(*IMFS_node_control_initialize)( const IMFS_types_union *info ); +/** + * @brief Initialize Default IMFS Node + */ IMFS_jnode_t *IMFS_node_initialize_default( IMFS_jnode_t *node, const IMFS_types_union *info @@ -172,12 +181,18 @@ typedef IMFS_jnode_t *(*IMFS_node_control_remove)( IMFS_jnode_t *node ); +/** + * @brief Remove Default IMFS Node + */ IMFS_jnode_t *IMFS_node_remove_default( IMFS_jnode_t *node ); typedef IMFS_jnode_t *(*IMFS_node_control_destroy)( IMFS_jnode_t *node ); +/** + * @brief Destroy Default IMFS Node + */ IMFS_jnode_t *IMFS_node_destroy_default( IMFS_jnode_t *node ); typedef struct { @@ -298,6 +313,9 @@ extern int miniIMFS_initialize( const void *data ); +/** + * @brief IMFS Initialization Support + */ extern int IMFS_initialize_support( rtems_filesystem_mount_table_entry_t *mt_entry, const rtems_filesystem_operations_table *op_table, @@ -322,21 +340,44 @@ extern void IMFS_dump( void ); */ extern int IMFS_memfile_maximum_size( void ); +/** + * @brief Destroy IMFS Node + */ extern void IMFS_node_destroy( IMFS_jnode_t *node ); +/** + * @brief Clone IMFS Node + */ extern int IMFS_node_clone( rtems_filesystem_location_info_t *loc ); +/** + * @brief Free IMFS Node + */ extern void IMFS_node_free( const rtems_filesystem_location_info_t *loc ); +/** + * @brief IMFS Node Type + * + * The following verifies that returns the type of node that the + * loc refers to. + */ extern rtems_filesystem_node_types_t IMFS_node_type( const rtems_filesystem_location_info_t *loc ); +/** + * @brief IMFS Stat + * + * This routine provides a stat for the IMFS file system. + */ extern int IMFS_stat( const rtems_filesystem_location_info_t *loc, struct stat *buf ); +/** + * @brief Evaluation IMFS Node Support + */ extern void IMFS_eval_path( rtems_filesystem_eval_path_context_t *ctx ); @@ -362,6 +403,11 @@ extern int IMFS_mknod( dev_t dev ); +/** + * @brief Create a New IMFS Node + * + * Routine to create a new in memory file system node. + */ extern IMFS_jnode_t *IMFS_allocate_node( IMFS_fs_info_t *fs_info, const IMFS_node_control *node_control, @@ -371,6 +417,12 @@ extern IMFS_jnode_t *IMFS_allocate_node( const IMFS_types_union *info ); +/** + * @brief Create an IMFS Node + * + * Create an IMFS filesystem node of an arbitrary type that is NOT + * the root directory node. + */ extern IMFS_jnode_t *IMFS_create_node_with_control( const rtems_filesystem_location_info_t *parentloc, const IMFS_node_control *node_control, @@ -391,6 +443,9 @@ extern int IMFS_make_generic_node( void *context ); +/** + * @brief Mount an IMFS + */ extern int IMFS_mount( rtems_filesystem_mount_table_entry_t *mt_entry /* IN */ ); @@ -433,6 +488,16 @@ extern ssize_t memfile_write( size_t count /* IN */ ); +/** + * @name IMFS Device Node Handlers + * + * This section contains the set of handlers used to map operations on + * IMFS device nodes onto calls to the RTEMS Classic API IO Manager. + * + * @{ + */ + + extern int device_open( rtems_libio_t *iop, /* IN */ const char *pathname, /* IN */ @@ -467,12 +532,24 @@ extern int device_ftruncate( off_t length /* IN */ ); +/** @} */ + +/** + * @brief Set IMFS File Access and Modification Times + * + * + * This routine is the implementation of the utime() system + * call for the IMFS. + */ extern int IMFS_utime( const rtems_filesystem_location_info_t *loc, time_t actime, time_t modtime ); +/** + * @brief Change IMFS File Mode + */ extern int IMFS_fchmod( const rtems_filesystem_location_info_t *loc, mode_t mode diff --git a/cpukit/libfs/src/imfs/imfs_creat.c b/cpukit/libfs/src/imfs/imfs_creat.c index 3950dba70b..830480b83e 100644 --- a/cpukit/libfs/src/imfs/imfs_creat.c +++ b/cpukit/libfs/src/imfs/imfs_creat.c @@ -1,8 +1,10 @@ -/* - * IMFS_create_node() - * - * Routine to create a new in memory file system node. +/** + * @file * + * @brief Create an IMFS Node + * @ingroup IMFS + */ +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * @@ -83,10 +85,6 @@ IMFS_jnode_t *IMFS_allocate_node( return (*node->control->node_initialize)( node, info ); } -/* - * Create an IMFS filesystem node of an arbitrary type that is NOT - * the root directory node. - */ IMFS_jnode_t *IMFS_create_node_with_control( const rtems_filesystem_location_info_t *parentloc, const IMFS_node_control *node_control, diff --git a/cpukit/libfs/src/imfs/imfs_eval.c b/cpukit/libfs/src/imfs/imfs_eval.c index 4fcfd67ee9..5abb2473b3 100644 --- a/cpukit/libfs/src/imfs/imfs_eval.c +++ b/cpukit/libfs/src/imfs/imfs_eval.c @@ -1,6 +1,11 @@ -/* - * Evaluation IMFS Node Support Routines +/** + * @file * + * @brief Evaluation IMFS Node Support + * @ingroup IMFS + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libfs/src/imfs/imfs_fchmod.c b/cpukit/libfs/src/imfs/imfs_fchmod.c index dfd6eaf3bc..ccb344629e 100644 --- a/cpukit/libfs/src/imfs/imfs_fchmod.c +++ b/cpukit/libfs/src/imfs/imfs_fchmod.c @@ -1,6 +1,11 @@ -/* - * IMFS file change mode routine. +/** + * @file * + * @brief Change IMFS File Mode + * @ingroup IMFS + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libfs/src/imfs/imfs_initsupp.c b/cpukit/libfs/src/imfs/imfs_initsupp.c index 3bb8a979fc..a68fff178f 100644 --- a/cpukit/libfs/src/imfs/imfs_initsupp.c +++ b/cpukit/libfs/src/imfs/imfs_initsupp.c @@ -1,6 +1,11 @@ -/* - * IMFS Initialization +/** + * @file * + * @brief IMFS Node Support + * @ingroup IMFS + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libfs/src/imfs/imfs_mount.c b/cpukit/libfs/src/imfs/imfs_mount.c index f8e9d72f5a..49c3cae45c 100644 --- a/cpukit/libfs/src/imfs/imfs_mount.c +++ b/cpukit/libfs/src/imfs/imfs_mount.c @@ -1,6 +1,11 @@ -/* - * IMFS_mount +/** + * @file * + * @brief Mount an IMFS + * @ingroup IMFS + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libfs/src/imfs/imfs_ntype.c b/cpukit/libfs/src/imfs/imfs_ntype.c index e955606fe2..fd9056279d 100644 --- a/cpukit/libfs/src/imfs/imfs_ntype.c +++ b/cpukit/libfs/src/imfs/imfs_ntype.c @@ -1,9 +1,11 @@ -/* - * IMFS_node_type - * - * The following verifies that returns the type of node that the - * loc refers to. +/** + * @file * + * @brief IMFS Node Type + * @ingroup IMFS + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libfs/src/imfs/imfs_stat.c b/cpukit/libfs/src/imfs/imfs_stat.c index 8f373c6287..87f03551ad 100644 --- a/cpukit/libfs/src/imfs/imfs_stat.c +++ b/cpukit/libfs/src/imfs/imfs_stat.c @@ -1,8 +1,11 @@ -/* - * IMFS_stat - * - * This routine provides a stat for the IMFS file system. +/** + * @file * + * @brief IMFS Stat + * @ingroup IMFS + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libfs/src/imfs/imfs_utime.c b/cpukit/libfs/src/imfs/imfs_utime.c index 5eee799d7e..aa7d455c3a 100644 --- a/cpukit/libfs/src/imfs/imfs_utime.c +++ b/cpukit/libfs/src/imfs/imfs_utime.c @@ -1,9 +1,11 @@ -/* - * IMFS_utime - * - * This routine is the implementation of the utime() system - * call for the IMFS. +/** + * @file * + * @brief Set IMFS File Access and Modification Times + * @ingroup IMFS + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libfs/src/imfs/ioman.c b/cpukit/libfs/src/imfs/ioman.c index 8b434e7e8c..27ec89ad21 100644 --- a/cpukit/libfs/src/imfs/ioman.c +++ b/cpukit/libfs/src/imfs/ioman.c @@ -1,7 +1,11 @@ -/* - * This file emulates the old Classic RTEMS IO manager directives - * which register and lookup names using the in-memory filesystem. +/** + * @file * + * @brief RTMES Register IO Name + * @ingroup ClassicIO + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -22,12 +26,6 @@ #include <rtems/libio_.h> -/* - * rtems_io_register_name - * - * This assumes that all registered devices are character devices. - */ - rtems_status_code rtems_io_register_name( const char *device_name, rtems_device_major_number major, |