stddef: Fix kerndoc for sizeof_field() and offsetofend()
authorKees Cook <keescook@chromium.org>
Thu, 19 Aug 2021 20:42:43 +0000 (13:42 -0700)
committerKees Cook <keescook@chromium.org>
Sat, 25 Sep 2021 15:20:47 +0000 (08:20 -0700)
Adjust the comment styles so these are correctly identified as valid
kern-doc.

Signed-off-by: Kees Cook <keescook@chromium.org>
include/linux/stddef.h

index 998a4ba..8553b33 100644 (file)
@@ -20,7 +20,7 @@ enum {
 #endif
 
 /**
- * sizeof_field(TYPE, MEMBER)
+ * sizeof_field() - Report the size of a struct field in bytes
  *
  * @TYPE: The structure containing the field of interest
  * @MEMBER: The field to return the size of
@@ -28,7 +28,7 @@ enum {
 #define sizeof_field(TYPE, MEMBER) sizeof((((TYPE *)0)->MEMBER))
 
 /**
- * offsetofend(TYPE, MEMBER)
+ * offsetofend() - Report the offset of a struct field within the struct
  *
  * @TYPE: The type of the structure
  * @MEMBER: The member within the structure to get the end offset of