Re: [PATCH] drm/amd/display: dc.h: eliminate kernel-doc warnings

[Harry Wentland]

On 2023-07-11 22:23, Randy Dunlap wrote:
> Quash 175 kernel-doc warnings in dc.h by unmarking 2 struct
> comments as containing kernel-doc notation and by spelling one
> struct field correctly in a kernel-doc comment.
> 
> Fixes: 1682bd1a6b5f ("drm/amd/display: Expand kernel doc for DC")
> Fixes: ea76895ffab1 ("drm/amd/display: Document pipe split policy")
> Fixes: f6ae69f49fcf ("drm/amd/display: Include surface of unaffected streams")
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: Harry Wentland <harry.wentland@xxxxxxx>
> Cc: Leo Li <sunpeng.li@xxxxxxx>
> Cc: Rodrigo Siqueira <Rodrigo.Siqueira@xxxxxxx>
> Cc: Aurabindo Pillai <aurabindo.pillai@xxxxxxx>
> Cc: Alex Deucher <alexander.deucher@xxxxxxx>
> Cc: amd-gfx@xxxxxxxxxxxxxxxxxxxxx
> Cc: Alex Deucher <alexander.deucher@xxxxxxx>
> Cc: Christian König <christian.koenig@xxxxxxx>
> Cc: "Pan, Xinhui" <Xinhui.Pan@xxxxxxx>
> Cc: dri-devel@xxxxxxxxxxxxxxxxxxxxx

Reviewed-by: Harry Wentland <harry.wentland@xxxxxxx>

Harry

> ---
>  drivers/gpu/drm/amd/display/dc/dc.h |    8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff -- a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h
> --- a/drivers/gpu/drm/amd/display/dc/dc.h
> +++ b/drivers/gpu/drm/amd/display/dc/dc.h
> @@ -506,7 +506,7 @@ enum dcn_zstate_support_state {
>  	DCN_ZSTATE_SUPPORT_DISALLOW,
>  };
>  
> -/**
> +/*
>   * struct dc_clocks - DC pipe clocks
>   *
>   * For any clocks that may differ per pipe only the max is stored in this
> @@ -728,7 +728,7 @@ struct resource_pool;
>  struct dce_hwseq;
>  struct link_service;
>  
> -/**
> +/*
>   * struct dc_debug_options - DC debug struct
>   *
>   * This struct provides a simple mechanism for developers to change some
> @@ -756,7 +756,7 @@ struct dc_debug_options {
>  	bool use_max_lb;
>  	enum dcc_option disable_dcc;
>  
> -	/**
> +	/*
>  	 * @pipe_split_policy: Define which pipe split policy is used by the
>  	 * display core.
>  	 */
> @@ -1334,7 +1334,7 @@ struct dc_validation_set {
>  	struct dc_stream_state *stream;
>  
>  	/**
> -	 * @plane_state: Surface state
> +	 * @plane_states: Surface state
>  	 */
>  	struct dc_plane_state *plane_states[MAX_SURFACES];
>