[PATCH] drm/amd/display: Fix up kdoc for 'optc35_set_odm_combine'

[Rodrigo Siqueira Jordao]

Hi,

Consider renaming the commit title to something like "Adjust kernel-doc 
for ...". Anyway, avoid use the keyword "Fix/Fixes" for kernel-doc.

On 8/28/23 22:50, Srinivasan Shanmugam wrote:
> Fixes the following W=1 kernel build warning:
> 
> drivers/gpu/drm/amd/amdgpu/../display/dc/dcn35/dcn35_optc.c:46: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> * Enable CRTC
> 
> Cc: Qingqing Zhuo <Qingqing.Zhuo at amd.com>
> Cc: Rodrigo Siqueira <Rodrigo.Siqueira at amd.com>
> Cc: Harry Wentland <harry.wentland at amd.com>
> Cc: Aurabindo Pillai <aurabindo.pillai at amd.com>
> Cc: Alex Deucher <alexander.deucher at amd.com>
> Signed-off-by: Srinivasan Shanmugam <srinivasan.shanmugam at amd.com>
> ---
>   drivers/gpu/drm/amd/display/dc/dcn35/dcn35_optc.c | 11 ++++++++---
>   1 file changed, 8 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/gpu/drm/amd/display/dc/dcn35/dcn35_optc.c b/drivers/gpu/drm/amd/display/dc/dcn35/dcn35_optc.c
> index 5f7adc83258b..294799d8c34e 100644
> --- a/drivers/gpu/drm/amd/display/dc/dcn35/dcn35_optc.c
> +++ b/drivers/gpu/drm/amd/display/dc/dcn35/dcn35_optc.c
> @@ -43,10 +43,15 @@
>   	optc1->tg_shift->field_name, optc1->tg_mask->field_name
>   
>   /**
> - * Enable CRTC
> - * Enable CRTC - call ASIC Control Object to enable Timing generator.
> + * optc35_set_odm_combine() - Enable CRTC - call ASIC Control Object to enable Timing generator.
> + *
> + * @optc: timing_generator instance.

How about:

@optc: Output Pipe Timing Combine instance reference.

> + * @opp_id: OPP instance.

How about:

@opp_id: Output Plane Processor instance ID.

Thanks
Siqueira

> + * @opp_cnt: OPP count.
> + * @timing: Timing parameters used to configure DCN blocks.
> + *
> + * Return: void.
>    */
> -
>   static void optc35_set_odm_combine(struct timing_generator *optc, int *opp_id, int opp_cnt,
>   		struct dc_crtc_timing *timing)
>   {