Completed code documentation for ectty.
authorFlorian Pose <fp@igh-essen.com>
Mon, 19 Apr 2010 21:51:01 +0200
changeset 1903 5b526d0f5a5d
parent 1902 d1a44889bc4f
child 1904 2fadf016d9be
Completed code documentation for ectty.
include/ectty.h
--- a/include/ectty.h	Mon Apr 19 21:49:59 2010 +0200
+++ b/include/ectty.h	Mon Apr 19 21:51:01 2010 +0200
@@ -51,12 +51,13 @@
 struct ec_tty;
 typedef struct ec_tty ec_tty_t; /**< \see ec_tty */
 
-/**
- * \param cflag_changed This callback function is called when the serial
- * settings shall be changed. The \a cflag argument contains the new settings.
+/** Operations on the virtual TTY interface.
  */
 typedef struct {
-    int (*cflag_changed)(void *, tcflag_t);
+    int (*cflag_changed)(void *, tcflag_t); /**< Called when the serial
+                                              * settings shall be changed. The
+                                              * \a cflag argument contains the
+                                              * new settings. */
 } ec_tty_operations_t;
 
 /******************************************************************************