Re: [PATCH] drm: panel: Fully transition panel_desc kerneldoc to inline style

[Sam Ravnborg]

Hi Douglas,

On Tue, Dec 01, 2020 at 12:59:12PM -0800, Douglas Anderson wrote:
> In commit 131f909ad55f ("drm: panel: simple: Fixup the struct
> panel_desc kernel doc") I transitioned the more deeply nested
> kerneldoc comments into the inline style.  Apparently it is desirable
> to continue the job and move _everything_ in this struct to inline.
> Let's do it.
> 
> While doing this, we also add a short summary for the whole struct to
> fix a warning when we run with extra warnings, AKA:
>   scripts/kernel-doc -v -rst drivers/gpu/drm/panel/panel-simple.c
> 
> The warning was:
>   drivers/gpu/drm/panel/panel-simple.c:42: warning: missing initial short description on line:
>    * struct panel_desc
> 
> Suggested-by: Sam Ravnborg <sam@xxxxxxxxxxxx>
> Signed-off-by: Douglas Anderson <dianders@xxxxxxxxxxxx>
> Cc: Douglas Anderson <dianders@xxxxxxxxxxxx>
> Cc: Sam Ravnborg <sam@xxxxxxxxxxxx>
> Cc: Thierry Reding <thierry.reding@xxxxxxxxx>
> Cc: dri-devel@xxxxxxxxxxxxxxxxxxxxx
> ---
> 
>  drivers/gpu/drm/panel/panel-simple.c | 43 +++++++++++++++++-----------
>  1 file changed, 27 insertions(+), 16 deletions(-)
> 
> diff --git a/drivers/gpu/drm/panel/panel-simple.c b/drivers/gpu/drm/panel/panel-simple.c
> index 216cde33b5c4..33d53abdb1fb 100644
> --- a/drivers/gpu/drm/panel/panel-simple.c
> +++ b/drivers/gpu/drm/panel/panel-simple.c
> @@ -39,31 +39,36 @@
>  #include <drm/drm_panel.h>
>  
>  /**
> - * struct panel_desc
> - * @modes: Pointer to array of fixed modes appropriate for this panel.  If
> - *         only one mode then this can just be the address of this the mode.
While applying I fixed this up like this:
> - *         only one mode then this can just be the address of the mode.

Applied to drm-misc-next - thanks for doing this. Much nicer now.

	Sam