libfs: Doxygen Enhancement Task #2

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

3 files changed, 37 insertions, 35 deletions

diff --git a/cpukit/libfs/src/pipe/fifo.c b/cpukit/libfs/src/pipe/fifo.c
index 06eacd712f..ba5e7b7e40 100644
--- a/cpukit/libfs/src/pipe/fifo.c
+++ b/cpukit/libfs/src/pipe/fifo.c
@@ -1,6 +1,11 @@
-/*
- * fifo.c: POSIX FIFO/pipe for RTEMS
+/**
+ * @file
  *
+ * @brief FIFO/Pipe Support
+ * @ingroup FIFO_PIPE
+ */
+
+/*
  * Author: Wei Shen <cquark@gmail.com>
  *
  * The license and distribution terms for this file may be
@@ -236,12 +241,6 @@ out:
   return err;
 }
 
-/*
- * Interface to file system close.
- *
- * *pipep points to pipe control structure. When the last user releases pipe,
- * it will be set to NULL.
- */
 void pipe_release(
   pipe_control_t **pipep,
   rtems_libio_t *iop
@@ -299,13 +298,6 @@ void pipe_release(
 
 }
 
-/*
- * Interface to file system open.
- *
- * *pipep points to pipe control structure. If called with *pipep = NULL,
- * fifo_open will try allocating and initializing a control structure. If the
- * call succeeds, *pipep will be set to address of new control structure.
- */
 int fifo_open(
   pipe_control_t **pipep,
   rtems_libio_t *iop
@@ -387,9 +379,6 @@ out_error:
   return err;
 }
 
-/*
- * Interface to file system read.
- */
 ssize_t pipe_read(
   pipe_control_t *pipe,
   void           *buffer,
@@ -459,9 +448,6 @@ out_nolock:
   return ret;
 }
 
-/*
- * Interface to file system write.
- */
 ssize_t pipe_write(
   pipe_control_t *pipe,
   const void     *buffer,
@@ -545,9 +531,6 @@ out_nolock:
   return ret;
 }
 
-/*
- * Interface to file system ioctl.
- */
 int pipe_ioctl(
   pipe_control_t  *pipe,
   ioctl_command_t  cmd,
diff --git a/cpukit/libfs/src/pipe/pipe.c b/cpukit/libfs/src/pipe/pipe.c
index 2fc9952cac..ed64dbb1aa 100644
--- a/cpukit/libfs/src/pipe/pipe.c
+++ b/cpukit/libfs/src/pipe/pipe.c
@@ -1,6 +1,11 @@
-/*
- * pipe.c: anonymous pipe
+/**
+ * @file
  *
+ * @brief Create an Anonymous Pipe
+ * @ingroup FIFO_PIPE
+ */
+
+/*
  * Author: Wei Shen <cquark@gmail.com>
  *
  * The license and distribution terms for this file may be
@@ -22,9 +27,6 @@
 /* FIXME: This approach is questionable */
 static uint16_t rtems_pipe_no = 0;
 
-/*
- * Called by pipe() to create an anonymous pipe.
- */
 int pipe_create(
   int filsdes[2]
 )
diff --git a/cpukit/libfs/src/pipe/pipe.h b/cpukit/libfs/src/pipe/pipe.h
index 29e7542b43..6ba3c5ef42 100644
--- a/cpukit/libfs/src/pipe/pipe.h
+++ b/cpukit/libfs/src/pipe/pipe.h
@@ -22,6 +22,12 @@
 extern "C" {
 #endif
 
+/**
+ * @defgroup FIFO_PIPE FIFO/pipe File System Support
+ * 
+ * @brief Interface to the POSIX FIFO/pipe File System
+ */
+
 /* Control block to manage each pipe */
 typedef struct pipe_control {
   char *Buffer;
@@ -42,14 +48,18 @@ typedef struct pipe_control {
 #endif
 } pipe_control_t;
 
-/*
+/**
+ * @brief Create an Anonymous Pipe
+ * 
  * Called by pipe() to create an anonymous pipe.
  */
 extern int pipe_create(
   int filsdes[2]
 );
 
-/*
+/**
+ * @brief Release a Pipe
+ * 
  * Interface to file system close.
  *
  * *pipep points to pipe control structure. When the last user releases pipe,
@@ -60,7 +70,8 @@ extern void pipe_release(
   rtems_libio_t *iop
 );
 
-/*
+/**
+ * @brief FIFO Open
  * Interface to file system open.
  *
  * *pipep points to pipe control structure. If called with *pipep = NULL,
@@ -72,7 +83,9 @@ extern int fifo_open(
   rtems_libio_t *iop
 );
 
-/*
+/**
+ * @brief Pipe Read
+ * 
  * Interface to file system read.
  */
 extern ssize_t pipe_read(
@@ -82,7 +95,9 @@ extern ssize_t pipe_read(
   rtems_libio_t  *iop
 );
 
-/*
+/**
+ * @brief Pipe Write
+ * 
  * Interface to file system write.
  */
 extern ssize_t pipe_write(
@@ -92,7 +107,9 @@ extern ssize_t pipe_write(
   rtems_libio_t  *iop
 );
 
-/*
+/**
+ * @brief Pipe IO Control
+ * 
  * Interface to file system ioctl.
  */
 extern int pipe_ioctl(