diff options
Diffstat (limited to 'ace/TTY_IO.h')
| -rw-r--r-- | ace/TTY_IO.h | 59 |
1 files changed, 29 insertions, 30 deletions
diff --git a/ace/TTY_IO.h b/ace/TTY_IO.h index 75e0eff5ced..e716aebe741 100644 --- a/ace/TTY_IO.h +++ b/ace/TTY_IO.h @@ -1,20 +1,15 @@ /* -*- C++ -*- */ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// TTY_IO.h -// -// = DESCRIPTION -// -// = AUTHOR -// Douglas C. Schmidt <schmidt@uci.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file TTY_IO.h + * + * $Id$ + * + * @author Douglas C. Schmidt <schmidt@uci.edu> + */ +//============================================================================= + #ifndef ACE_TTY_IO_H #define ACE_TTY_IO_H @@ -29,28 +24,32 @@ #include "ace/DEV_Connector.h" #include "ace/DEV_IO.h" +/** + * @class ACE_TTY_IO + * + * @brief Class definitions for platform specific TTY features. + * + * This class represents an example interface for a specific + * device (a serial line) It extends the capability of the + * underlying DEV_IO class by adding a control method that takes + * a special structure (Serial_Params) as argument to allow a + * comfortable user interface (away from that annoying termios + * structure, which is very specific to UNIX). + */ class ACE_Export ACE_TTY_IO : public ACE_DEV_IO { - // = TITLE - // Class definitions for platform specific TTY features. - // - // = DESCRIPTION - // This class represents an example interface for a specific - // device (a serial line) It extends the capability of the - // underlying DEV_IO class by adding a control method that takes - // a special structure (Serial_Params) as argument to allow a - // comfortable user interface (away from that annoying termios - // structure, which is very specific to UNIX). public: enum Control_Mode { - SETPARAMS, // Set control parameters. - GETPARAMS // Get control parameters. + /// Set control parameters. + SETPARAMS, + /// Get control parameters. + GETPARAMS }; struct Serial_Params { - // Common params + // Common params int baudrate; int parityenb; const char *paritymode; @@ -71,13 +70,13 @@ public: int xofflim; // max bytes in input buffer before xoff }; + /// Interface for reading/writing serial device parameters. int control (Control_Mode cmd, Serial_Params *arg) const; - // Interface for reading/writing serial device parameters. #if defined (ACE_NEEDS_DEV_IO_CONVERSION) + /// This is necessary to pass ACE_TTY_IO as parameter to DEV_Connector. operator ACE_DEV_IO &(); - // This is necessary to pass ACE_TTY_IO as parameter to DEV_Connector. #endif /* ACE_NEEDS_DEV_IO_CONVERSION */ }; |