Re: [PATCH -next] drm/msm/dpu: Fix some kernel-doc comments

[Abhinav Kumar]

On 11/14/2022 5:49 PM, Yang Li wrote:
> Make the description of @init to @p in dpu_encoder_phys_wb_init()
> and remove @wb_roi in dpu_encoder_phys_wb_setup_fb() to clear the below
> warnings:
>
> drivers/gpu/drm/msm/disp/dpu1/dpu_encoder_phys_wb.c:139: warning: Excess function parameter 'wb_roi' description in 'dpu_encoder_phys_wb_setup_fb'
> drivers/gpu/drm/msm/disp/dpu1/dpu_encoder_phys_wb.c:699: warning: Function parameter or member 'p' not described in 'dpu_encoder_phys_wb_init'
> drivers/gpu/drm/msm/disp/dpu1/dpu_encoder_phys_wb.c:699: warning: Excess function parameter 'init' description in 'dpu_encoder_phys_wb_init'
>
> Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=3067
> Reported-by: Abaci Robot <abaci@xxxxxxxxxxxxxxxxx>
> Signed-off-by: Yang Li <yang.lee@xxxxxxxxxxxxxxxxx>

Fixes: d7d0e73f7de3 ("drm/msm/dpu: introduce the dpu_encoder_phys_* for 
writeback")

Reviewed-by: Abhinav Kumar <quic_abhinavk@xxxxxxxxxxx>
> ---
>   drivers/gpu/drm/msm/disp/dpu1/dpu_encoder_phys_wb.c | 3 +--
>   1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/drivers/gpu/drm/msm/disp/dpu1/dpu_encoder_phys_wb.c b/drivers/gpu/drm/msm/disp/dpu1/dpu_encoder_phys_wb.c
> index 7cbcef6efe17..62f6ff6abf41 100644
> --- a/drivers/gpu/drm/msm/disp/dpu1/dpu_encoder_phys_wb.c
> +++ b/drivers/gpu/drm/msm/disp/dpu1/dpu_encoder_phys_wb.c
> @@ -132,7 +132,6 @@ static void dpu_encoder_phys_wb_set_qos(struct dpu_encoder_phys *phys_enc)
>    * dpu_encoder_phys_wb_setup_fb - setup output framebuffer
>    * @phys_enc:	Pointer to physical encoder
>    * @fb:		Pointer to output framebuffer
> - * @wb_roi:	Pointer to output region of interest
>    */
>   static void dpu_encoder_phys_wb_setup_fb(struct dpu_encoder_phys *phys_enc,
>   		struct drm_framebuffer *fb)
> @@ -692,7 +691,7 @@ static void dpu_encoder_phys_wb_init_ops(struct dpu_encoder_phys_ops *ops)
>   
>   /**
>    * dpu_encoder_phys_wb_init - initialize writeback encoder
> - * @init:	Pointer to init info structure with initialization params
> + * @p:	Pointer to init info structure with initialization params
>    */
>   struct dpu_encoder_phys *dpu_encoder_phys_wb_init(
>   		struct dpu_enc_phys_init_params *p)