From 6ca4d5b96b54bdd6086c084631500e918b37ceb7 Mon Sep 17 00:00:00 2001 From: Simon Glass Date: Sat, 29 Oct 2022 19:47:04 -0600 Subject: sandbox: Add missing comments for os_alarm() Add the documentation to avoid a warning with 'make htmldocs'. Fixes: 10107efedd5 ("sandbox: add SIGALRM-based watchdog device") Signed-off-by: Simon Glass --- include/os.h | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'include/os.h') diff --git a/include/os.h b/include/os.h index 54874f5e0e8..0415f0f0e7a 100644 --- a/include/os.h +++ b/include/os.h @@ -110,6 +110,10 @@ void os_exit(int exit_code) __attribute__((noreturn)); /** * os_alarm() - access to the OS alarm() system call + * + * @seconds: number of seconds before the signal is sent + * Returns: number of seconds remaining until any previously scheduled alarm was + * due to be delivered; 0 if there was no previously scheduled alarm */ unsigned int os_alarm(unsigned int seconds); -- cgit v1.2.3