libfs: Doxygen Enhancement GCI Task #7

http://www.google-melange.com/gci/task/view/google/gci2012/8006219

9 files changed, 75 insertions, 3 deletions

diff --git a/cpukit/libfs/src/devfs/devfs.h b/cpukit/libfs/src/devfs/devfs.h
index 4155dd6884..3fd1fab036 100644
--- a/cpukit/libfs/src/devfs/devfs.h
+++ b/cpukit/libfs/src/devfs/devfs.h
@@ -13,10 +13,16 @@
 #ifdef __cplusplus
 extern "C" {
 #endif
-
 /**
- *  This structure define the type of device table
+ * @defgroup DevFsDeviceTable Define Device Table Type
+ *
+ * @ingroup DevFs
+ *
+ * @brief This structure defines the type of device table
+ *
+ * @{
  */
+
 typedef struct {
   /** This member points to device name which is not a null-terminated string */
   const char               *name;
@@ -56,11 +62,15 @@ static inline const devFS_data *devFS_get_data(
   return (const devFS_data *) loc->mt_entry->immutable_fs_info;
 }
 
+/**
+ *  @brief Evaluate Patch
+ */
 extern void devFS_eval_path(
   rtems_filesystem_eval_path_context_t *ctx
 );
 
 /**
+ *  @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.
@@ -90,6 +100,7 @@ extern int devFS_close(
 
 
 /**
+ *  @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
@@ -106,6 +117,7 @@ extern ssize_t devFS_read(
 
 
 /**
+ *  @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
@@ -122,6 +134,7 @@ extern ssize_t devFS_write(
 
 
 /**
+ *  @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
@@ -159,6 +172,7 @@ extern int devFS_stat(
 
 
 /**
+ *  @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.
@@ -173,6 +187,7 @@ extern rtems_filesystem_node_types_t devFS_node_type(
 );
 
 /**
+ *  @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
@@ -192,6 +207,7 @@ extern int devFS_mknod(
 
 
 /**
+ *  @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
@@ -225,7 +241,7 @@ extern int devFS_initialize(
  */
 
 extern void devFS_Show(void);
-
+/** @} */
 #ifdef __cplusplus
 }
 #endif
diff --git a/cpukit/libfs/src/devfs/devfs_eval.c b/cpukit/libfs/src/devfs/devfs_eval.c
index 6af27d6044..a313afca78 100644
--- a/cpukit/libfs/src/devfs/devfs_eval.c
+++ b/cpukit/libfs/src/devfs/devfs_eval.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Evaluate Patch
+ * @ingroup DevFsDeviceTable Define Device Table Type
+ */
+
 /*
  *  The license and distribution terms for this file may be
  *  found in the file LICENSE in this distribution or at
diff --git a/cpukit/libfs/src/devfs/devfs_init.c b/cpukit/libfs/src/devfs/devfs_init.c
index 7ec3d9f9be..e0dbe2fe4a 100644
--- a/cpukit/libfs/src/devfs/devfs_init.c
+++ b/cpukit/libfs/src/devfs/devfs_init.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Creates the Main Device Table
+ * @ingroup DevFsDeviceTable Define Device Table Type
+ */
+
 /*
  *  The license and distribution terms for this file may be
  *  found in the file LICENSE in this distribution or at
diff --git a/cpukit/libfs/src/devfs/devfs_mknod.c b/cpukit/libfs/src/devfs/devfs_mknod.c
index a2ab08a9f3..eeee4d8f1f 100644
--- a/cpukit/libfs/src/devfs/devfs_mknod.c
+++ b/cpukit/libfs/src/devfs/devfs_mknod.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Creates an item in the main device table.
+ * @ingroup DevFsDeviceTable Define Device Table Type
+ */
+
 /*
  *  The license and distribution terms for this file may be
  *  found in the file LICENSE in this distribution or at
diff --git a/cpukit/libfs/src/devfs/devfs_node_type.c b/cpukit/libfs/src/devfs/devfs_node_type.c
index db92c6c5d0..ed9ee8629f 100644
--- a/cpukit/libfs/src/devfs/devfs_node_type.c
+++ b/cpukit/libfs/src/devfs/devfs_node_type.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Invoked upon Determination of a Node Type
+ * @ingroup DevFsDeviceTable Define Device Table Type
+ */
+
 /*
  *  The license and distribution terms for this file may be
  *  found in the file LICENSE in this distribution or at
diff --git a/cpukit/libfs/src/devfs/devioctl.c b/cpukit/libfs/src/devfs/devioctl.c
index e1d62c4d78..2c5e7dbb2d 100644
--- a/cpukit/libfs/src/devfs/devioctl.c
+++ b/cpukit/libfs/src/devfs/devioctl.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Maps ioctl Operation to rtems_io_ioctl
+ * @ingroup DevFsDeviceTable Define Device Table Type
+ */
+
 /*
  *  The license and distribution terms for this file may be
  *  found in the file LICENSE in this distribution or at
diff --git a/cpukit/libfs/src/devfs/devopen.c b/cpukit/libfs/src/devfs/devopen.c
index 26450ab26b..2bd68a5d54 100644
--- a/cpukit/libfs/src/devfs/devopen.c
+++ b/cpukit/libfs/src/devfs/devopen.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Maps Open Operation to rtems_io_open
+ * @ingroup DevFsDeviceTable Define Device Table Type
+ */
+
 /*
  *  The license and distribution terms for this file may be
  *  found in the file LICENSE in this distribution or at
diff --git a/cpukit/libfs/src/devfs/devread.c b/cpukit/libfs/src/devfs/devread.c
index 25d69b0284..dac88e1946 100644
--- a/cpukit/libfs/src/devfs/devread.c
+++ b/cpukit/libfs/src/devfs/devread.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief DevFS Read
+ * @ingroup Read Operation to rtems_io_read
+ */
+
 /*
  *  The license and distribution terms for this file may be
  *  found in the file LICENSE in this distribution or at
diff --git a/cpukit/libfs/src/devfs/devwrite.c b/cpukit/libfs/src/devfs/devwrite.c
index 57e7fdb221..93087e271e 100644
--- a/cpukit/libfs/src/devfs/devwrite.c
+++ b/cpukit/libfs/src/devfs/devwrite.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Writes Operation to rtems_io_write
+ * @ingroup DevFsDeviceTable Define Device Table Type
+ */
+
 /*
  *  The license and distribution terms for this file may be
  *  found in the file LICENSE in this distribution or at