diff options
| author | Mathew Kallada <matkallada@gmail.com> | 2012-12-28 10:35:32 -0600 |
|---|---|---|
| committer | Jennifer Averett <jennifer.averett@oarcorp.com> | 2012-12-28 10:36:55 -0600 |
| commit | 9ab091e1e4b5572c0d327722dfbfd9d1bbccd405 (patch) | |
| tree | 934bc6440fc4dbf775a00181952433bdfeed0d9d /cpukit/libfs/src/pipe | |
| parent | libmisc/mouse: Doxygen Group Clean Up (diff) | |
| download | rtems-9ab091e1e4b5572c0d327722dfbfd9d1bbccd405.tar.bz2 | |
Header File Doxygen Enhancement Task #2
Diffstat (limited to 'cpukit/libfs/src/pipe')
| -rw-r--r-- | cpukit/libfs/src/pipe/pipe.h | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/cpukit/libfs/src/pipe/pipe.h b/cpukit/libfs/src/pipe/pipe.h index 6ba3c5ef42..158cde5e35 100644 --- a/cpukit/libfs/src/pipe/pipe.h +++ b/cpukit/libfs/src/pipe/pipe.h @@ -1,6 +1,8 @@ /** * @file rtems/pipe.h * + * @brief Defines the Interface to the POSIX FIFO/pipe File System Support + * * This include file defines the interface to the POSIX FIFO/pipe file system * support. */ @@ -24,7 +26,7 @@ extern "C" { /** * @defgroup FIFO_PIPE FIFO/pipe File System Support - * + * * @brief Interface to the POSIX FIFO/pipe File System */ @@ -50,7 +52,7 @@ typedef struct pipe_control { /** * @brief Create an Anonymous Pipe - * + * * Called by pipe() to create an anonymous pipe. */ extern int pipe_create( @@ -59,7 +61,7 @@ extern int pipe_create( /** * @brief Release a Pipe - * + * * Interface to file system close. * * *pipep points to pipe control structure. When the last user releases pipe, @@ -85,7 +87,7 @@ extern int fifo_open( /** * @brief Pipe Read - * + * * Interface to file system read. */ extern ssize_t pipe_read( @@ -97,7 +99,7 @@ extern ssize_t pipe_read( /** * @brief Pipe Write - * + * * Interface to file system write. */ extern ssize_t pipe_write( @@ -109,7 +111,7 @@ extern ssize_t pipe_write( /** * @brief Pipe IO Control - * + * * Interface to file system ioctl. */ extern int pipe_ioctl( |