2024-03-06 03:32:34

by R Sundar

[permalink] [raw]
Subject: [PATCH] Removed redundant @ symbol to fix kernel-doc warnings in -next repo

For linux-next repository.

/drivers/gpu/drm/amd/display/dc/inc/hw/hubp.h:1: warning: no structured comments found
/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:132: warning: Incorrect use of kernel-doc format: * @@overlap_only: Whether overlapping of different planes is allowed.
/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:132: warning: Incorrect use of kernel-doc format: * @@overlap_only: Whether overlapping of different planes is allowed.
/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:1: warning: no structured comments found
/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:132: warning: Incorrect use of kernel-doc format: * @@overlap_only: Whether overlapping of different planes is allowed.
/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:162: warning: Function parameter or struct member 'pre_multiplied_alpha' not described in 'mpcc_blnd_cfg'

Signed-off-by: R SUNDAR <[email protected]>
---
drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
index ba9b942ce09f..34a398f23fc6 100644
--- a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
+++ b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
@@ -110,9 +110,8 @@ struct mpcc_blnd_cfg {
*/
enum mpcc_alpha_blend_mode alpha_mode;

- /***
- * @@pre_multiplied_alpha:
- *
+ /**
+ * @pre_multiplied_alpha:
* Whether pixel color values were pre-multiplied by the alpha channel
* (MPCC_ALPHA_MULTIPLIED_MODE).
*/
@@ -129,7 +128,7 @@ struct mpcc_blnd_cfg {
int global_alpha;

/**
- * @@overlap_only: Whether overlapping of different planes is allowed.
+ * @overlap_only: Whether overlapping of different planes is allowed.
*/
bool overlap_only;

--
2.34.1



2024-03-06 18:07:53

by Alex Deucher

[permalink] [raw]
Subject: Re: [PATCH] Removed redundant @ symbol to fix kernel-doc warnings in -next repo

Fixed up patch title prefix and applied.

Thanks!

Alex

On Tue, Mar 5, 2024 at 10:48 PM R SUNDAR <[email protected]> wrote:
>
> For linux-next repository.
>
> ./drivers/gpu/drm/amd/display/dc/inc/hw/hubp.h:1: warning: no structured comments found
> ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:132: warning: Incorrect use of kernel-doc format: * @@overlap_only: Whether overlapping of different planes is allowed.
> ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:132: warning: Incorrect use of kernel-doc format: * @@overlap_only: Whether overlapping of different planes is allowed.
> ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:1: warning: no structured comments found
> ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:132: warning: Incorrect use of kernel-doc format: * @@overlap_only: Whether overlapping of different planes is allowed.
> ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:162: warning: Function parameter or struct member 'pre_multiplied_alpha' not described in 'mpcc_blnd_cfg'
>
> Signed-off-by: R SUNDAR <[email protected]>
> ---
> drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h | 7 +++----
> 1 file changed, 3 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> index ba9b942ce09f..34a398f23fc6 100644
> --- a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> +++ b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> @@ -110,9 +110,8 @@ struct mpcc_blnd_cfg {
> */
> enum mpcc_alpha_blend_mode alpha_mode;
>
> - /***
> - * @@pre_multiplied_alpha:
> - *
> + /**
> + * @pre_multiplied_alpha:
> * Whether pixel color values were pre-multiplied by the alpha channel
> * (MPCC_ALPHA_MULTIPLIED_MODE).
> */
> @@ -129,7 +128,7 @@ struct mpcc_blnd_cfg {
> int global_alpha;
>
> /**
> - * @@overlap_only: Whether overlapping of different planes is allowed.
> + * @overlap_only: Whether overlapping of different planes is allowed.
> */
> bool overlap_only;
>
> --
> 2.34.1
>