drm/xe: Fix type and parameter name mismatches in kernel-doc references

Fix kernel-doc references that point to wrong type or parameter names:

- xe_guc_capture_types.h: register_data_type ->
  capture_register_data_type to match actual enum name
- xe_oa_types.h: enum @drm_xe_oa_format_type ->
  enum drm_xe_oa_format_type (spurious '@' before type name)
- xe_pt_walk.h: @sizes -> @shifts to match actual struct member,
  @start -> @addr to match actual parameter name,
  page.table. -> page table. (typo)

Assisted-by: GitHub Copilot:claude-sonnet-4.6
Reviewed-by: Brian Nguyen <brian3.nguyen@intel.com>
Link: https://patch.msgid.link/20260414225457.3687449-5-shuicheng.lin@intel.com
Signed-off-by: Shuicheng Lin <shuicheng.lin@intel.com>
This commit is contained in:
Shuicheng Lin 2026-04-14 22:54:33 +00:00
parent 7f46eefbf5
commit ec7cae5899
3 changed files with 5 additions and 5 deletions

View File

@ -32,7 +32,7 @@ struct __guc_mmio_reg_descr {
/**
* @data_type: data type of the register
* Could be 32 bit, low or hi dword of a 64 bit, see enum
* register_data_type
* capture_register_data_type
*/
enum capture_register_data_type data_type;
/** @flags: Flags for the register */

View File

@ -67,7 +67,7 @@ struct xe_oa_format {
u32 counter_select;
/** @size: record size as written by HW (multiple of 64 byte cachelines) */
int size;
/** @type: of enum @drm_xe_oa_format_type */
/** @type: of enum drm_xe_oa_format_type */
int type;
/** @header: 32 or 64 bit report headers */
enum xe_oa_report_header header;

View File

@ -34,7 +34,7 @@ struct xe_pt_walk {
* changed during the walk.
*/
const u64 *shifts;
/** @max_level: Highest populated level in @sizes */
/** @max_level: Highest populated level in @shifts */
unsigned int max_level;
/**
* @shared_pt_mode: Whether to skip all entries that are private
@ -49,7 +49,7 @@ struct xe_pt_walk {
/**
* typedef xe_pt_entry_fn - gpu page-table-walk callback-function
* @parent: The parent page.table.
* @parent: The parent page table.
* @offset: The offset (number of entries) into the page table.
* @level: The level of @parent.
* @addr: The virtual address.
@ -118,7 +118,7 @@ static inline bool xe_pt_covers(u64 addr, u64 end, unsigned int level,
* @level: Page table level.
* @walk: Walk info.
*
* Return: The number of page table entries at this level between @start and
* Return: The number of page table entries at this level between @addr and
* @end.
*/
static inline pgoff_t