From: Simon Glass <sjg@chromium.org>
Date: Sun, 30 Oct 2022 01:47:04 +0000 (-0600)
Subject: sandbox: Add missing comments for os_alarm()
X-Git-Url: http://git.dujemihanovic.xyz/img/sics.gif?a=commitdiff_plain;h=6ca4d5b96b54bdd6086c084631500e918b37ceb7;p=u-boot.git

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 <sjg@chromium.org>
---

diff --git a/include/os.h b/include/os.h
index 54874f5e0e..0415f0f0e7 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);