[PATCH v2] device property: mark internal data as private for kernel-doc
Randy Dunlap <[email protected]>
| Newsgroups | dev.linux.lists.driver-core,org.kernel.vger.linux-acpi,org.kernel.vger.linux-kernel |
|---|---|
| Message-ID | <[email protected]> |
Mark the @value union members as private since they are an internal representation of @value. This prevents kernel-doc warnings: Warning: include/linux/property.h:406 struct member 'u8_data' not described in 'property_entry' Warning: include/linux/property.h:406 struct member 'u16_data' not described in 'property_entry' Warning: include/linux/property.h:406 struct member 'u32_data' not described in 'property_entry' Warning: include/linux/property.h:406 struct member 'u64_data' not described in 'property_entry' Warning: include/linux/property.h:406 struct member 'str' not described in 'property_entry' Signed-off-by: Randy Dunlap <[email protected]> --- v2: use private: for the internal representation of @value (Andy S.). drop Sakari's Ack since the patch changed. Cc: Andy Shevchenko <[email protected]> Cc: Daniel Scally <[email protected]> Cc: Heikki Krogerus <[email protected]> Cc: Sakari Ailus <[email protected]> Cc: [email protected] Cc: Greg Kroah-Hartman <[email protected]> Cc: "Rafael J. Wysocki" <[email protected]> Cc: Danilo Krummrich <[email protected]> Cc: [email protected] include/linux/property.h | 2 ++ 1 file changed, 2 insertions(+) --- linux-next-20260720.orig/include/linux/property.h +++ linux-next-20260720/include/linux/property.h @@ -397,11 +397,13 @@ struct property_entry { union { const void *pointer; union { + /* private: internal representation of @value */ u8 u8_data[sizeof(u64) / sizeof(u8)]; u16 u16_data[sizeof(u64) / sizeof(u16)]; u32 u32_data[sizeof(u64) / sizeof(u32)]; u64 u64_data[sizeof(u64) / sizeof(u64)]; const char *str[sizeof(u64) / sizeof(char *)]; + /* public: */ } value; }; };