`make htmldocs` reports
./include/sandbox_host.h:14: warning:
cannot understand function prototype: 'enum host_platform_flags '
Align the description with Sphinx style.
Fixes: 93e9af685fef ("test: bootdev: scan with a broken high-priority device")
Signed-off-by: Heinrich Schuchardt <[email protected]>
Reviewed-by: Denis Mukhin <[email protected]>
---
v2:
fix typo: %s/boken/broken/
---
include/sandbox_host.h | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/include/sandbox_host.h b/include/sandbox_host.h
index 1330358ef7a..815b32487e7 100644
--- a/include/sandbox_host.h
+++ b/include/sandbox_host.h
@@ -9,10 +9,12 @@
#define __SANDBOX_HOST__
/**
- * Device flags.
+ * enum host_platform_flags - device flags
+ *
*/
enum host_platform_flags {
- HOST_FLAG_BROKEN = BIT(0), /** Simulate broken device */
+ /** @HOST_FLAG_BROKEN: simulate broken device */
+ HOST_FLAG_BROKEN = BIT(0),
};
/**
--
2.53.0
