Completed code documentation for ectty.

2010-04-19 21:51:01 +02:00 · 2010-04-19 21:51:01 +02:00 · 6a0b016c7c
parent d6ffe982f2
commit 6a0b016c7c
1 changed files with 5 additions and 4 deletions
--- a/include/ectty.h
+++ b/include/ectty.h
@ -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;

 /******************************************************************************