drm/msm/dpu: Fix some kernel-doc comments
PATCH 1/1 drm/msm/dpu: Fix some kernel-doc comments
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'
--- drivers/gpu/drm/msm/disp/dpu1/dpu_encoder_phys_wb.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
drivers/gpu/drm/msm/disp/dpu1/dpu_encoder_phys_wb.c +1 -2
@@ -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)
Signature · 1 line
2.20.1.7.g153144c
Quoted 11 lines · Yang Li
Make the description of @init to @p in
dpu_encoder_phys_wb_init()and remove @wb_roi indpu_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'Reported-by Abaci Robot <[email protected]>Signed-off-by Yang Li <[email protected]>
Quoted 25 lines
--- drivers/gpu/drm/msm/disp/dpu1/dpu_encoder_phys_wb.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)drivers/gpu/drm/msm/disp/dpu1/dpu_encoder_phys_wb.c +1
-2@@ -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)