summaryrefslogtreecommitdiffstats
path: root/cpukit/libfs/src/pipe/pipe.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/libfs/src/pipe/pipe.h')
-rw-r--r--cpukit/libfs/src/pipe/pipe.h43
1 files changed, 25 insertions, 18 deletions
diff --git a/cpukit/libfs/src/pipe/pipe.h b/cpukit/libfs/src/pipe/pipe.h
index 6ba3c5ef42..e9b9117f54 100644
--- a/cpukit/libfs/src/pipe/pipe.h
+++ b/cpukit/libfs/src/pipe/pipe.h
@@ -1,5 +1,7 @@
/**
- * @file rtems/pipe.h
+ * @file
+ *
+ * @brief POSIX FIFO/pipe File System Support
*
* This include file defines the interface to the POSIX FIFO/pipe file system
* support.
@@ -18,16 +20,19 @@
#include <rtems/libio.h>
+/**
+ * @defgroup FIFO_PIPE FIFO/Pipe File System Support
+ *
+ * @ingroup FileSystemTypesAndMount
+ *
+ * @brief Interface to the POSIX FIFO/Pipe File System
+ */
+/**@{*/
+
#ifdef __cplusplus
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;
@@ -49,8 +54,8 @@ 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.
*/
extern int pipe_create(
@@ -58,8 +63,8 @@ extern int pipe_create(
);
/**
- * @brief Release a Pipe
- *
+ * @brief Release a pipe.
+ *
* Interface to file system close.
*
* *pipep points to pipe control structure. When the last user releases pipe,
@@ -71,7 +76,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,
@@ -84,8 +89,8 @@ extern int fifo_open(
);
/**
- * @brief Pipe Read
- *
+ * @brief File system read.
+ *
* Interface to file system read.
*/
extern ssize_t pipe_read(
@@ -96,8 +101,8 @@ extern ssize_t pipe_read(
);
/**
- * @brief Pipe Write
- *
+ * @brief File system write.
+ *
* Interface to file system write.
*/
extern ssize_t pipe_write(
@@ -108,8 +113,8 @@ extern ssize_t pipe_write(
);
/**
- * @brief Pipe IO Control
- *
+ * @brief File system Input/Output control.
+ *
* Interface to file system ioctl.
*/
extern int pipe_ioctl(
@@ -119,6 +124,8 @@ extern int pipe_ioctl(
rtems_libio_t *iop
);
+/** @} */
+
#ifdef __cplusplus
}
#endif