summaryrefslogtreecommitdiffstats
path: root/cpukit/libfs/src/pipe
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2013-01-08 09:02:58 -0500
committerGedare Bloom <gedare@rtems.org>2013-01-08 09:02:58 -0500
commite354eb4f4fbd602adede59138c819eb94e7c1488 (patch)
tree50a219aab9a9d69d1e53bf45f38ff15476dd0b0c /cpukit/libfs/src/pipe
parentsapi: Doxygen Clean Up Task #1 (diff)
downloadrtems-e354eb4f4fbd602adede59138c819eb94e7c1488.tar.bz2
libfs: Doxygen Clean Up Task #1
http://www.google-melange.com/gci/task/view/google/gci2012/8120204 Patch committed with fixes for whitespace issues.
Diffstat (limited to 'cpukit/libfs/src/pipe')
-rw-r--r--cpukit/libfs/src/pipe/pipe.h20
1 files changed, 12 insertions, 8 deletions
diff --git a/cpukit/libfs/src/pipe/pipe.h b/cpukit/libfs/src/pipe/pipe.h
index 158cde5e35..f51855c173 100644
--- a/cpukit/libfs/src/pipe/pipe.h
+++ b/cpukit/libfs/src/pipe/pipe.h
@@ -1,7 +1,7 @@
/**
- * @file rtems/pipe.h
+ * @file
*
- * @brief Defines the Interface to the POSIX FIFO/pipe File System Support
+ * @brief POSIX FIFO/pipe File System Support
*
* This include file defines the interface to the POSIX FIFO/pipe file system
* support.
@@ -28,6 +28,8 @@ extern "C" {
* @defgroup FIFO_PIPE FIFO/pipe File System Support
*
* @brief Interface to the POSIX FIFO/pipe File System
+ *
+ * @{
*/
/* Control block to manage each pipe */
@@ -51,7 +53,7 @@ typedef struct pipe_control {
} pipe_control_t;
/**
- * @brief Create an Anonymous Pipe
+ * @brief Create an anonymous pipe.
*
* Called by pipe() to create an anonymous pipe.
*/
@@ -60,7 +62,7 @@ extern int pipe_create(
);
/**
- * @brief Release a Pipe
+ * @brief Release a pipe.
*
* Interface to file system close.
*
@@ -73,7 +75,7 @@ extern void pipe_release(
);
/**
- * @brief FIFO Open
+ * @brief File system open.
* Interface to file system open.
*
* *pipep points to pipe control structure. If called with *pipep = NULL,
@@ -86,7 +88,7 @@ extern int fifo_open(
);
/**
- * @brief Pipe Read
+ * @brief File system read.
*
* Interface to file system read.
*/
@@ -98,7 +100,7 @@ extern ssize_t pipe_read(
);
/**
- * @brief Pipe Write
+ * @brief File system write.
*
* Interface to file system write.
*/
@@ -110,7 +112,7 @@ extern ssize_t pipe_write(
);
/**
- * @brief Pipe IO Control
+ * @brief File system Input/Output control.
*
* Interface to file system ioctl.
*/
@@ -121,6 +123,8 @@ extern int pipe_ioctl(
rtems_libio_t *iop
);
+/** @} */
+
#ifdef __cplusplus
}
#endif