drm/xe: Document nested struct members according to guidelines
authorThomas Hellström <thomas.hellstrom@linux.intel.com>
Tue, 23 Jan 2024 15:31:47 +0000 (16:31 +0100)
committerThomas Hellström <thomas.hellstrom@linux.intel.com>
Tue, 23 Jan 2024 15:54:41 +0000 (16:54 +0100)
commit6240c2c43fd062515dda68e60866b4851f32d631
tree97d7f42ec4eb45ea4f1b546ef9bb2763b53f3305
parent02c4e64a860a05ca3ffe4d416c1ae9003d3453ea
drm/xe: Document nested struct members according to guidelines

Document nested struct members with full names as described in
Documentation/doc-guide/kernel-doc.rst.

For this documentation we allow a column width of 100 to make
it more readable.

This fixes warnings similar to:
drivers/gpu/drm/xe/xe_lrc_types.h:45: warning: Excess struct member 'size' description in 'xe_lrc'

v2:
- Only change the documentation, not the member.

v3:
- Fix the commit message wording.

Cc: Lucas De Marchi <lucas.demarchi@intel.com>
Cc: Matthew Brost <matthew.brost@intel.com>
Signed-off-by: Thomas Hellström <thomas.hellstrom@linux.intel.com>
Reviewed-by: Lucas De Marchi <lucas.demarchi@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20240123153147.27305-1-thomas.hellstrom@linux.intel.com
12 files changed:
drivers/gpu/drm/xe/xe_device_types.h
drivers/gpu/drm/xe/xe_exec_queue_types.h
drivers/gpu/drm/xe/xe_gsc_types.h
drivers/gpu/drm/xe/xe_gt_types.h
drivers/gpu/drm/xe/xe_guc_ct_types.h
drivers/gpu/drm/xe/xe_guc_submit_types.h
drivers/gpu/drm/xe/xe_guc_types.h
drivers/gpu/drm/xe/xe_hw_engine_types.h
drivers/gpu/drm/xe/xe_lrc_types.h
drivers/gpu/drm/xe/xe_sched_job_types.h
drivers/gpu/drm/xe/xe_uc_fw_types.h
drivers/gpu/drm/xe/xe_wopcm_types.h