[linux-safety] [PATCH] include/linux/build_bug.h: Add documentation

"Milan Lakhani" <[email protected]> Wed, 10 Feb 2021 22:21:55 +0000
Newsgroups tech.elisa.lists.linux-safety
Message-ID <[email protected]>
Add missing documentation describing function parameters of macros,
thus removing warnings.

Signed-off-by: Milan Lakhani <[email protected]>
---
 include/linux/build_bug.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

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
-- 
2.7.4



-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#239): https://lists.elisa.tech/g/linux-safety/message/239
Mute This Topic: https://lists.elisa.tech/mt/80544677/5278000
Group Owner: [email protected]
Unsubscribe: https://lists.elisa.tech/g/linux-safety/unsub [[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-