]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
drm/xe/uapi: Fix kernel-doc cross-reference syntax in xe_drm.h
authorShuicheng Lin <shuicheng.lin@intel.com>
Tue, 7 Apr 2026 03:00:44 +0000 (03:00 +0000)
committerShuicheng Lin <shuicheng.lin@intel.com>
Wed, 8 Apr 2026 16:22:26 +0000 (09:22 -0700)
commit4bd87e7c4d467ce1f9e3b56abebeffc2ba45a2fb
tree8cead8cd2086b253e360eb3e2c57b5d8bd0ffb61
parentea842c235828152258fc5197212e896bc59d7b83
drm/xe/uapi: Fix kernel-doc cross-reference syntax in xe_drm.h

Fix incorrect kernel-doc cross-reference markup syntax
throughout xe_drm.h:
- @struct_name -> &struct name for cross-references to other
  structs (19 occurrences)
- struct @name -> &struct name where struct keyword was
  mixed with @ syntax (8 occurrences)
- enum @name -> &enum name for cross-references to other
  enums (5 occurrences)
- &CONSTANT / @CONSTANT -> %CONSTANT for defines and enum
  values (15 occurrences)
- @field references to members of other structs -> plain text,
  since @ only applies to the current struct's members
  (9 occurrences)

Per kernel-doc conventions (Documentation/doc-guide/kernel-doc.rst):
- '&struct name' creates hyperlinks to struct definitions
- '&enum name' creates hyperlinks to enum definitions
- '%NAME' references constants and defines
- '@name' is only for parameters/members of the current context

Assisted-by: GitHub Copilot:claude-opus-4.6
Suggested-by: Xin Wang <x.wang@intel.com>
Reviewed-by: Xin Wang <x.wang@intel.com>
Link: https://patch.msgid.link/20260407030046.3394004-5-shuicheng.lin@intel.com
Signed-off-by: Shuicheng Lin <shuicheng.lin@intel.com>
include/uapi/drm/xe_drm.h