[PATCH v2] drm/amd/display: Adjust kdoc for 'optc35_set_odm_combine'

[Rodrigo Siqueira Jordao]

On 8/29/23 08:38, 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>
> ---
> 
> v2:
> 
> - Addressed the following comments (Rodrigo)
>    - Updated Commit title to 'drm/amd/display: Adjust kdoc for 'optc35_set_odm_combine'
>    - Updated the description for paramaters @optc, opp_id, opp_cnt.
> 
>   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..d64be1a5071c 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: Output Pipe Timing Combine instance reference.
> + * @opp_id: Output Plane Processor instance ID.
> + * @opp_cnt: Output Plane Processor 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)
>   {

When sending a new patch version, send it as a new patch instead of 
replying the previous one.

Anyway,

Reviewed-by: Rodrigo Siqueira <Rodrigo.Siqueira at amd.com>