]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
drm/xe: Add missing '@' prefix to kernel-doc member tags
authorShuicheng Lin <shuicheng.lin@intel.com>
Tue, 14 Apr 2026 22:54:31 +0000 (22:54 +0000)
committerShuicheng Lin <shuicheng.lin@intel.com>
Thu, 16 Apr 2026 15:31:59 +0000 (08:31 -0700)
Add the required '@' prefix to member documentation tags that were
missing it. Without the prefix, kernel-doc does not associate the
comment with the struct member.

- xe_guc_ct_types.h: snapshot_ct -> @snapshot_ct,
  snapshot_log -> @snapshot_log
- xe_pagefault_types.h: consumer.reserved -> @consumer.reserved
- xe_pt_types.h: addr -> @addr

Assisted-by: GitHub Copilot:claude-sonnet-4.6
Reviewed-by: Brian Nguyen <brian3.nguyen@intel.com>
Link: https://patch.msgid.link/20260414225457.3687449-3-shuicheng.lin@intel.com
Signed-off-by: Shuicheng Lin <shuicheng.lin@intel.com>
drivers/gpu/drm/xe/xe_guc_ct_types.h
drivers/gpu/drm/xe/xe_pagefault_types.h
drivers/gpu/drm/xe/xe_pt_types.h

index c81996f8915acc3c9d25bef70c32185dcf2a5d58..f88e588af0d3d6923024ee372ff18b6dddd092f5 100644 (file)
@@ -102,9 +102,9 @@ struct xe_dead_ct {
        bool reported;
        /** @worker: worker thread to get out of interrupt context before dumping */
        struct work_struct worker;
-       /** snapshot_ct: copy of CT state and CTB content at point of error */
+       /** @snapshot_ct: copy of CT state and CTB content at point of error */
        struct xe_guc_ct_snapshot *snapshot_ct;
-       /** snapshot_log: copy of GuC log at point of error */
+       /** @snapshot_log: copy of GuC log at point of error */
        struct xe_guc_log_snapshot *snapshot_log;
 };
 
index b3289219b1be5f346f1de5510feb1688527d95f9..aa3cfae01b9c037adacc7072dec27645cb8a1f89 100644 (file)
@@ -86,7 +86,7 @@ struct xe_pagefault {
                u8 engine_class;
                /** @consumer.engine_instance: engine instance */
                u8 engine_instance;
-               /** consumer.reserved: reserved bits for future expansion */
+               /** @consumer.reserved: reserved bits for future expansion */
                u64 reserved;
        } consumer;
        /**
index 84b51d3762a4d4eae5ce56937606a14ec0a2b6cb..a7d1bb708b69e71f4a14d756c1ac1a6b5c5eadcd 100644 (file)
@@ -34,7 +34,7 @@ struct xe_pt {
        bool rebind;
        bool is_compact;
 #if IS_ENABLED(CONFIG_DRM_XE_DEBUG_VM)
-       /** addr: Virtual address start address of the PT. */
+       /** @addr: Virtual address start address of the PT. */
        u64 addr;
 #endif
 };