[PATCH] drm/amd/display: Use a plain comment for panel polarity declarations

[PATCH] drm/amd/display: Use a plain comment for panel polarity declarations

[Weijie Yuan]

Hi, when running 'make htmldocs', Sphinx complains:

WARNING: ./drivers/gpu/drm/amd/display/dc/dc.h:3883 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
 * Panel Polarity Control

But since I am not familiar with your workflow, if this is duplicate,
please feel free to ignore.

Also for this file:

WARNING: ./drivers/gpu/drm/amd/display/dc/dc.h:329 struct member 'max_gamut_remap_coeff' not described in 'mpc_color_caps'
WARNING: ./drivers/gpu/drm/amd/display/dc/dc.h:2225 struct member 'u' not described in 'dc_probe_status'
WARNING: ./drivers/gpu/drm/amd/display/dc/dc.h:329 struct member 'max_gamut_remap_coeff' not described in 'mpc_color_caps'
WARNING: ./drivers/gpu/drm/amd/display/dc/dc.h:2225 struct member 'u' not described in 'dc_probe_status'

Thanks.

-- >8 --
From: Weijie Yuan <wy@wyuan.org>

The Panel Polarity Control heading introduces several declarations
rather than documenting a single function. Its kernel-doc opener
causes a warning because the heading is not a valid kernel-doc block.

Use an ordinary block comment for this section heading.

Fixes: 7dcd85c2241f ("drm/amd/display: eDP panel polarity control and test support")
Signed-off-by: Weijie Yuan <wy@wyuan.org>
---
 drivers/gpu/drm/amd/display/dc/dc.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h
index d3c484f45333..03286f6aa651 100644
--- a/drivers/gpu/drm/amd/display/dc/dc.h
+++ b/drivers/gpu/drm/amd/display/dc/dc.h
@@ -3880,7 +3880,7 @@ unsigned int dc_override_memory_bandwidth_request(
 		struct dc *dc,
 		unsigned int bw_mbps);
 
-/**
+/*
  * Panel Polarity Control
  */
 void dc_link_set_panel_polarity_enable(struct dc_link *link, bool enable);
-- 
2.56.0.438.g30c3f27cb8

Re: [PATCH] drm/amd/display: Use a plain comment for panel polarity declarations

[Wayne Lin]

Reviewed-by: Wayne Lin <Wayne.Lin@amd.com>

On Fri, 30 Oct 2026 20:27:13 +0800, Weijie Yuan wrote:
> Hi, when running 'make htmldocs', Sphinx complains:
>
> WARNING: ./drivers/gpu/drm/amd/display/dc/dc.h:3883 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
>  * Panel Polarity Control
>
> But since I am not familiar with your workflow, if this is duplicate,
> please feel free to ignore.
>
> Also for this file:
>
> WARNING: ./drivers/gpu/drm/amd/display/dc/dc.h:329 struct member 'max_gamut_remap_coeff' not described in 'mpc_color_caps'
> WARNING: ./drivers/gpu/drm/amd/display/dc/dc.h:2225 struct member 'u' not described in 'dc_probe_status'
> WARNING: ./drivers/gpu/drm/amd/display/dc/dc.h:329 struct member 'max_gamut_remap_coeff' not described in 'mpc_color_caps'
> WARNING: ./drivers/gpu/drm/amd/display/dc/dc.h:2225 struct member 'u' not described in 'dc_probe_status'
>
> Thanks.
>
> -- >8 --
> From: Weijie Yuan <wy@wyuan.org>
>
> The Panel Polarity Control heading introduces several declarations
> rather than documenting a single function. Its kernel-doc opener
> causes a warning because the heading is not a valid kernel-doc block.
>
> Use an ordinary block comment for this section heading.
>
> Fixes: 7dcd85c2241f ("drm/amd/display: eDP panel polarity control and test support")
> Signed-off-by: Weijie Yuan <wy@wyuan.org>
> ---
>  drivers/gpu/drm/amd/display/dc/dc.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h
> index d3c484f45333..03286f6aa651 100644
> --- a/drivers/gpu/drm/amd/display/dc/dc.h
> +++ b/drivers/gpu/drm/amd/display/dc/dc.h
> @@ -3880,7 +3880,7 @@ unsigned int dc_override_memory_bandwidth_request(
>  		struct dc *dc,
>  		unsigned int bw_mbps);
>  
> -/**
> +/*
>   * Panel Polarity Control
>   */
>  void dc_link_set_panel_polarity_enable(struct dc_link *link, bool enable);
> -- 
> 2.56.0.438.g30c3f27cb8