diff mbox series

include/linux/build_bug.h: Add documentation

Message ID 1612995715-37324-1-git-send-email-milan.lakhani@codethink.co.uk (mailing list archive)
State New, archived
Headers show
Series include/linux/build_bug.h: Add documentation | expand

Commit Message

Milan Lakhani Feb. 10, 2021, 10:21 p.m. UTC 
Add missing documentation describing function parameters of macros,
thus removing warnings.

Signed-off-by: Milan Lakhani <milan.lakhani@codethink.co.uk>
---
 include/linux/build_bug.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/include/linux/build_bug.h b/include/linux/build_bug.h
index e3a0be2..457c5f2 100644
--- a/include/linux/build_bug.h
+++ b/include/linux/build_bug.h
@@ -32,7 +32,8 @@ 
 /**
  * BUILD_BUG_ON_MSG - break compile if a condition is true & emit supplied
  *		      error message.
- * @condition: the condition which the compiler should know is false.
+ * @cond: the condition which the compiler should know is false.
+ * @msg: the error message to show when the condition is true.
  *
  * See BUILD_BUG_ON for description.
  */
@@ -60,6 +61,8 @@ 
 
 /**
  * static_assert - check integer constant expression at build time
+ * @expr: the integer constant expression which the compiler should know is
+ * true.
  *
  * static_assert() is a wrapper for the C11 _Static_assert, with a
  * little macro magic to make the message optional (defaulting to the