devfs: Doxygen Warning Removal and Cleanup

1 files changed, 56 insertions, 41 deletions

diff --git a/cpukit/libfs/src/devfs/devfs.h b/cpukit/libfs/src/devfs/devfs.h
index fbeb13bca5..850a892a36 100644
--- a/cpukit/libfs/src/devfs/devfs.h
+++ b/cpukit/libfs/src/devfs/devfs.h
@@ -1,7 +1,7 @@
 /**
 * @file 
 * 
-* @brief 'device-only' File System Support
+* @brief Device Only File System
 *  
 * This include file contains all constants and structures associated
 * with the 'device-only' filesystem.
@@ -25,6 +25,12 @@
 extern "C" {
 #endif
 
+/**
+ *  @brief Per Device Node Control Structure
+ *
+ *  This structure is instanced per device node and contains all information
+ *  used by this file system implementation to manage that device node.
+ */
 typedef struct {
   /** This member points to device name which is not a null-terminated string */
   const char               *name;
@@ -40,23 +46,27 @@ typedef struct {
 
 typedef struct {
   devFS_node *nodes;
-  size_t count;
+  size_t      count;
 } devFS_data;
 
 /**
  *  The following defines the device-only filesystem operating
  *  operations.
  */
-
 extern const rtems_filesystem_operations_table devFS_ops;
 
 /**
  *  The following defines the device-only filesystem operating
  *  handlers.
  */
-
 extern const rtems_filesystem_file_handlers_r  devFS_file_handlers;
 
+/**
+ * @brief Obtain Immutable Pointer to Immutable File System Data
+ *
+ * This methods returns the immutable file system specific information
+ * associated with this file.
+ */
 static inline const devFS_data *devFS_get_data(
   const rtems_filesystem_location_info_t *loc
 )
@@ -65,7 +75,7 @@ static inline const devFS_data *devFS_get_data(
 }
 
 /**
- *  @brief Evaluate Patch
+ *  @brief Evaluate Path
  */
 extern void devFS_eval_path(
   rtems_filesystem_eval_path_context_t *ctx
@@ -73,14 +83,16 @@ extern void devFS_eval_path(
 
 /**
  *  @brief Maps Open Operation to rtems_io_open
+ *
  *  This handler maps open operation to rtems_io_open.
+ *
  *  @param iop This is the RTEMS's internal representation of file.
  *  @param pathname a null-terminated string that starts with /dev.
- *  @param flag access flags
+ *  @param oflag access flags
  *  @param mode access mode
+ *
  *  @retval the same as open
  */
-
 extern int devFS_open(
   rtems_libio_t *iop,
   const char    *pathname,
@@ -93,107 +105,110 @@ extern int devFS_open(
  *  @brief Maps Close Operation to rtems_io_close
  *
  *  This handler maps close operation to rtems_io_close.
+ *
  *  @param iop This is the RTEMS's internal representation of file
+ *
  *  @retval the same as close
  */
-
-
 extern int devFS_close(
   rtems_libio_t *iop
 );
 
-
 /**
  *  @brief Maps Read Operation to rtems_io_read
+ *
  *  This handler maps read operation to rtems_io_read.
+ *
  *  @param iop This is the RTEMS's internal representation of file
  *  @param  buffer memory location to store read data
  *  @param  count  how many bytes to read
+ *
  *  @retval On successful, this routine returns total bytes read. On error
  *  it returns -1 and errno is set to proper value.
  */
-
 extern ssize_t devFS_read(
   rtems_libio_t *iop,
   void          *buffer,
   size_t         count
 );
 
-
 /**
  *  @brief Writes Operation to rtems_io_write
+ *
  *  This handler maps write operation to rtems_io_write.
+ *
  *  @param iop This is the RTEMS's internal representation of file
  *  @param buffer data to be written
  *  @param count  how many bytes to write
+ *
  *  @retval On successful, this routine returns total bytes written. On error
  *  it returns -1 and errno is set to proper value.
  */
-
 extern ssize_t devFS_write(
   rtems_libio_t *iop,
   const void    *buffer,
   size_t         count
 );
 
-
 /**
  *  @brief Maps ioctl Operation to rtems_io_ioctl
+ *
  *  This handler maps ioctl operation to rtems_io_ioctl.
+ *
  *  @param iop This is the RTEMS's internal representation of file
  *  @param command io control command
  *  @param buffer  io control parameters
+ *
  *  @retval On successful, this routine returns total bytes written. On error
  *  it returns -1 and errno is set to proper value.
  */
-
 extern int devFS_ioctl(
   rtems_libio_t   *iop,
   ioctl_command_t  command,
   void            *buffer
 );
 
-
-
-
 /**
  *  @brief Gets the Device File Information
  *
- *  This handler gets the device file information. This routine only set the following member of struct stat:
- *  st_dev : device number
- *  st_mode: device file creation mode, only two mode are accepted:
- *           S_IFCHR: character device file
- *           S_IFBLK: block device file
+ *  This handler gets the device file information. This routine only
+ *  set the following member of struct stat:
+ *
+ *  - st_dev: device number
+ *  - st_mode: device file creation mode, only two mode are accepted:
+ *    + S_IFCHR: character device file
+ *    + S_IFBLK: block device file
+ *
  *  @param loc contains filesystem access information
  *  @param buf buffer to hold the device file's information
+ *
  *  @retval On successful, this routine returns 0. On error
  *  it returns -1 and errno is set to proper value.
  */
-
 extern int devFS_stat(
   const rtems_filesystem_location_info_t *loc,
-  struct stat *buf
+  struct stat                            *buf
 );
 
-
-
 /**
  *  @brief Invoked upon Determination of a Node Type
+ *
  *  This routine is invoked upon determination of a node type.
  *  Since this is a device-only filesystem, so there is only
  *  one node type in the system.
  *
  *  @param loc contains filesytem access information, this
  *         parameter is ignored
+ *
  *  @retval always returns RTEMS_FILESYSTEM_DEVICE
  */
-
 extern rtems_filesystem_node_types_t devFS_node_type(
   const rtems_filesystem_location_info_t*loc
 );
 
 /**
  *  @brief Creates an item in the main device table.
+ *
  *  This routine is invoked upon registration of a new device
  *  file. It is responsible for creating a item in the main
  *  device table. This routine searches the device table in
@@ -202,18 +217,17 @@ extern rtems_filesystem_node_types_t devFS_node_type(
  *
  *  @see rtems_filesystem_mknod_t.
  */
-
 extern int devFS_mknod(
   const rtems_filesystem_location_info_t *parentloc,
-  const char *name,
-  size_t namelen,
-  mode_t mode,
-  dev_t dev
+  const char                             *name,
+  size_t                                  namelen,
+  mode_t                                  mode,
+  dev_t                                   dev
 );
 
-
 /**
  *  @brief Creates the Main Device Table
+ *
  *  This routine is invoked upon rtems filesystem initialization.
  *  It is responsible for creating the main device table,
  *  initializing it to a known state, and set device file operation
@@ -221,17 +235,16 @@ extern int devFS_mknod(
  *
  *  @param  mt_entry The filesystem mount table entry.
  *  @param  data Filesystem specific data.
+ *
  *  @retval upon success, this routine returns 0; otherwise it returns
  *  -1 and errno is set to proper value. The only error is when malloc
  *  failed, and errno is set to NOMEM.
  */
-
 extern int devFS_initialize(
   rtems_filesystem_mount_table_entry_t *mt_entry,
   const void                           *data
 );
 
-
 /**
  *  @brief Retrieves and Prints all the Device Registered in System
  *
@@ -239,16 +252,18 @@ extern int devFS_initialize(
  *  prints out their detail information. For example, on one system,
  *  devFS_show will print out following message:
  *
- *  /dev/console     0  0
- *  /dev/clock       1  0
- *  /dev/tty0        0  0
- *  /flash           2  0
+ *  @code
+ *    /dev/console     0  0
+ *    /dev/clock       1  0
+ *    /dev/tty0        0  0
+ *    /flash           2  0
+ *  @end code
  *
  *  This routine is intended for debugging, and can be used by shell
  *  program to provide user with the system information.
  */
-
 extern void devFS_Show(void);
+
 /** @} */
 #ifdef __cplusplus
 }