timer/migration: Fix kernel-doc warnings for union tmigr_state

Use the correct kernel-doc notation for nested structs/unions to
eliminate warnings:

timer_migration.h:119: warning: Incorrect use of kernel-doc format:          * struct - split state of tmigr_group
timer_migration.h:134: warning: Function parameter or struct member 'active' not described in 'tmigr_state'
timer_migration.h:134: warning: Function parameter or struct member 'migrator' not described in 'tmigr_state'
timer_migration.h:134: warning: Function parameter or struct member 'seq' not described in 'tmigr_state'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/all/20250111063156.910903-1-rdunlap@infradead.org

diff --git a/kernel/time/timer_migration.h b/kernel/time/timer_migration.h
index 154accc7a543c4d1a5f90980496c3471e48ff34e..ae19f70f8170fd6834b542f8998c4798fd477bce 100644 (file)
--- a/kernel/time/timer_migration.h
+++ b/kernel/time/timer_migration.h
@@ -110,22 +110,19 @@ struct tmigr_cpu {
  * union tmigr_state - state of tmigr_group
  * @state:     Combined version of the state - only used for atomic
  *             read/cmpxchg function
- * @struct:    Split version of the state - only use the struct members to
+ * &anon struct: Split version of the state - only use the struct members to
  *             update information to stay independent of endianness
+ * @active:    Contains each mask bit of the active children
+ * @migrator:  Contains mask of the child which is migrator
+ * @seq:       Sequence counter needs to be increased when an update
+ *             to the tmigr_state is done. It prevents a race when
+ *             updates in the child groups are propagated in changed
+ *             order. Detailed information about the scenario is
+ *             given in the documentation at the begin of
+ *             timer_migration.c.
  */
 union tmigr_state {
        u32 state;
-       /**
-        * struct - split state of tmigr_group
-        * @active:     Contains each mask bit of the active children
-        * @migrator:   Contains mask of the child which is migrator
-        * @seq:        Sequence counter needs to be increased when an update
-        *              to the tmigr_state is done. It prevents a race when
-        *              updates in the child groups are propagated in changed
-        *              order. Detailed information about the scenario is
-        *              given in the documentation at the begin of
-        *              timer_migration.c.
-        */
        struct {
                u8      active;
                u8      migrator;