From: Kees Cook <keescook@chromium.org>
Date: Thu, 19 Aug 2021 20:42:43 +0000 (-0700)
Subject: stddef: Fix kerndoc for sizeof_field() and offsetofend()
X-Git-Tag: microblaze-v5.18~654^2~27
X-Git-Url: http://git.monstr.eu/?a=commitdiff_plain;h=e7f18c22e6bea258ffd65185fdab66d1e63dd5bd;p=linux-2.6-microblaze.git

stddef: Fix kerndoc for sizeof_field() and offsetofend()

Adjust the comment styles so these are correctly identified as valid
kern-doc.

Signed-off-by: Kees Cook <keescook@chromium.org>
---

diff --git a/include/linux/stddef.h b/include/linux/stddef.h
index 998a4ba28eba..8553b33143d1 100644
--- a/include/linux/stddef.h
+++ b/include/linux/stddef.h
@@ -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