drivers: serial: document on_baudrate()

Add parameter description.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

diff --git a/drivers/serial/serial.c b/drivers/serial/serial.c
index c489deac2bba8c9a7c4ba627630df61d45bea0f5..c499601f000fef359f3176cd2dba5d87237c051a 100644 (file)
--- a/drivers/serial/serial.c
+++ b/drivers/serial/serial.c
@@ -36,7 +36,15 @@ static void serial_null(void)
 /**
  * on_baudrate() - Update the actual baudrate when the env var changes
  *
+ * @name:      changed environment variable
+ * @value:     new value of the environment variable
+ * @op:                operation (create, overwrite, or delete)
+ * @flags:     attributes of environment variable change,
+ *             see flags H_* in include/search.h
+ *
  * This will check for a valid baudrate and only apply it if valid.
+ *
+ * Return:     0 on success, 1 on error
  */
 static int on_baudrate(const char *name, const char *value, enum env_op op,
        int flags)