From a16ca03ca87eb5c1e046674906a70150e1fc7640 Mon Sep 17 00:00:00 2001 From: Joachim Wiberg Date: Tue, 19 Dec 2023 17:24:26 +0100 Subject: [PATCH] Update description and mention logo copyright Signed-off-by: Joachim Wiberg --- src/wdog.h | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/wdog.h b/src/wdog.h index 2423771..c961f87 100644 --- a/src/wdog.h +++ b/src/wdog.h @@ -15,7 +15,18 @@ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** libwdog API +/** The libwdog API defines how to connect to watchdogd at runtime to + * query status, including reset cause data, adjust logging, and for + * advanced users: to ask watchdogd to monitor a process. + * + * Please note, the logo, "Watch Dog Detective Taking Notes", is licensed + * for use by the watchdogd project, copyright © Ron Leishman + * + * Typically a process' event/@c while(1) loop is instrumented with a + * call to "kick" the watchdog periodically to inform watchdogd that it + * is still operational. See the included examples for how this can be + * used + * * @file wdog.h * @example ex1.c * @example ex2.c