The kernel-doc markup for i915_gem_apply_to_region_ops() has some issues: 1. The field should be marked as @process_obj; 2. The callback parameters aren't document properly, as sphinx will consider them to be placed at the wrong place. Fix (1) and change the way the parameters are described, using a list, in order for it to be properly parsed during documentation build time. Signed-off-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxx> --- To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/32] at: https://lore.kernel.org/all/cover.1657565224.git.mchehab@xxxxxxxxxx/ drivers/gpu/drm/i915/gem/i915_gem_region.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/drivers/gpu/drm/i915/gem/i915_gem_region.h b/drivers/gpu/drm/i915/gem/i915_gem_region.h index 2dfcc41c0170..b0134bf4b1b7 100644 --- a/drivers/gpu/drm/i915/gem/i915_gem_region.h +++ b/drivers/gpu/drm/i915/gem/i915_gem_region.h @@ -22,9 +22,11 @@ struct i915_gem_apply_to_region; */ struct i915_gem_apply_to_region_ops { /** - * process_obj - Process the current object - * @apply: Embed this for private data. - * @obj: The current object. + * @process_obj: Callback function to process the current object + * it requires two arguments: + * + * - @apply: Embed this for private data. + * - @obj: The current object. * * Note that if this function is part of a ww transaction, and * if returns -EDEADLK for one of the objects, it may be -- 2.36.1
