diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2013-01-07 08:53:43 -0600 |
|---|---|---|
| committer | Jennifer Averett <jennifer.averett@oarcorp.com> | 2013-01-07 08:53:43 -0600 |
| commit | cf301c96061bf0eedc327abdc7851216c37112c5 (patch) | |
| tree | 16614a66d4cff9b614f4e5c530fd85ca2ad8f3a8 /cpukit/posix/include/aio.h | |
| parent | score: Doxygen Clean Up Task #11 (diff) | |
| download | rtems-cf301c96061bf0eedc327abdc7851216c37112c5.tar.bz2 | |
posix: Doxygen Clean Up Task #1
Diffstat (limited to 'cpukit/posix/include/aio.h')
| -rw-r--r-- | cpukit/posix/include/aio.h | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/cpukit/posix/include/aio.h b/cpukit/posix/include/aio.h index 3ad7a400e6..769f0b37f2 100644 --- a/cpukit/posix/include/aio.h +++ b/cpukit/posix/include/aio.h @@ -31,6 +31,8 @@ extern "C" { * @ingroup POSIX * * @brief POSIX Asynchronous Input and Output + * + * @{ */ #if defined(_POSIX_ASYNCHRONOUS_IO) @@ -137,16 +139,18 @@ ssize_t aio_return( ); /** - * @brief Cancel Asynchronous I/O Operation + * @brief Cancel asynchronous I/O operation. * - * 6.7.7 Cancel Asynchronous I/O Operation, P1003.1b-1993, p. 163 + * 6.7.7 Cancel Asynchronous I/O Operation, P1003.1b-1993, p. 163 * - * @param[in] filedes is the file descriptor - * @param[in] aiocbp is the asynchronous I/O control block + * @param[in] filedes is the file descriptor + * @param[in] aiocbp is a pointer to the asynchronous I/O control block * - * @return This method returns AIO_CANCELED if the requested operation(s) - * were canceled. Otherwise, AIO_NOTCANCELED is returned indicating - * that at least one of the requested operation(s) cannot be canceled + * @retval AIO_CANCELED The requested operation(s) were canceled. + * @retval AIO_NOTCANCELED Some of the requested operation(s) cannot be + * canceled since they are in progress. + * @retval AIO_ALLDONE None of the requested operation(s) could be canceled + * since they are already complete */ int aio_cancel( int filedes, @@ -178,6 +182,8 @@ int aio_fsync( #endif /* _POSIX_ASYNCHRONOUS_IO */ +/** @} */ + #ifdef __cplusplus } #endif |