Re: [PATCH] drm/dp: Fix documentation warning
From: Dmitry Baryshkov
Date: Sun May 19 2024 - 05:09:28 EST
On Sun, May 19, 2024 at 12:10:27AM -0300, MarileneGarcia wrote:
> It fixes the following warnings when
> the kernel documentation is generated:
>
> ./include/drm/display/drm_dp_helper.h:126:
> warning: Function parameter or struct member
> 'mode' not described in 'drm_dp_as_sdp'
>
> ./include/drm/display/drm_dp_helper.h:126:
> warning: Excess struct member 'operation_mode'
> description in 'drm_dp_as_sdp'
>
> Signed-off-by: MarileneGarcia <marilene.agarcia@xxxxxxxxx>
> ---
> Changes:
> This documentation comment should refer to the name of the
> variable to solve the warnings. As operation_mode is the
> name of the enum, and the declared variable name is mode.
>
> Thank you.
>
> include/drm/display/drm_dp_helper.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
Fixes: 0bbb8f594e33 ("drm/dp: Add Adaptive Sync SDP logging")
Reviewed-by: Dmitry Baryshkov <dmitry.baryshkov@xxxxxxxxxx>
--
With best wishes
Dmitry