diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-09 17:55:17 -0500 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2012-12-09 17:55:17 -0500 |
| commit | bcd0ea64091d4c360b48cfabbfb94b4f562a9eaa (patch) | |
| tree | c19e154cfb32d246159933209e1c404be752e8e6 /cpukit/libcsupport/include/rtems/termiostypes.h | |
| parent | libcsupport: Fix documentation (diff) | |
| download | rtems-bcd0ea64091d4c360b48cfabbfb94b4f562a9eaa.tar.bz2 | |
libcsupport: Doxygen enhancement task #2
http://www.google-melange.com/gci/task/view/google/gci2012/8017203
Diffstat (limited to 'cpukit/libcsupport/include/rtems/termiostypes.h')
| -rw-r--r-- | cpukit/libcsupport/include/rtems/termiostypes.h | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/cpukit/libcsupport/include/rtems/termiostypes.h b/cpukit/libcsupport/include/rtems/termiostypes.h index 74653b0252..7f2a3eae84 100644 --- a/cpukit/libcsupport/include/rtems/termiostypes.h +++ b/cpukit/libcsupport/include/rtems/termiostypes.h @@ -26,6 +26,14 @@ extern "C" { #endif +/** + * @defgroup TermiostypesSupport RTEMS Termios Device Support + * + * @ingroup libcsupport + * + * @brief RTEMS Termios Device Support Internal Data Structures + */ + /* * Wakeup callback data structure */ @@ -186,11 +194,11 @@ typedef uint32_t rtems_termios_baud_t; extern const rtems_assoc_t rtems_termios_baud_table []; /** - * @brief Converts the integral baud value @a baud to the Termios control flag - * representation. + * @brief Converts the Integral Baud value @a baud to the Termios Control Flag + * Representation * - * @retval B0 Invalid baud value or a baud value of 0. - * @retval other Baud constant according to @a baud. + * @retval B0 Invalid baud value or a baud value of 0. + * @retval other Baud constant according to @a baud. */ tcflag_t rtems_termios_number_to_baud(rtems_termios_baud_t baud); @@ -205,7 +213,9 @@ tcflag_t rtems_termios_number_to_baud(rtems_termios_baud_t baud); */ rtems_termios_baud_t rtems_termios_baud_to_number(tcflag_t c_cflag); -/* convert Bxxx constant to index */ +/** + * @brief Convert Bxxx Constant to Index + */ int rtems_termios_baud_to_index(rtems_termios_baud_t termios_baud); /** |