From 938b05a5d796045a93a98ec17606c434c1339881 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Sun, 29 Jul 2018 10:41:02 +0200 Subject: [PATCH] drivers: serial: document on_baudrate() Add parameter description. Signed-off-by: Heinrich Schuchardt --- drivers/serial/serial.c | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/drivers/serial/serial.c b/drivers/serial/serial.c index c489deac2b..c499601f00 100644 --- 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) -- 2.25.1