drm: panel: Fully transition panel_desc kerneldoc to inline style

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@ravnborg.org>
Signed-off-by: Douglas Anderson <dianders@chromium.org>
Cc: Douglas Anderson <dianders@chromium.org>
Cc: Sam Ravnborg <sam@ravnborg.org>
Cc: Thierry Reding <thierry.reding@gmail.com>
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Link: https://patchwork.freedesktop.org/patch/msgid/20201201125822.1.I3c4191336014bd57364309439e56f600c94bb12b@changeid

diff --git a/drivers/gpu/drm/panel/panel-simple.c b/drivers/gpu/drm/panel/panel-simple.c
index 216cde33b5c4c5be0551a11ae65e3a1b5fe168af..faa45af48c152480a8ce23111c766e783a1223af 100644 (file)
--- 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.
- *         NOTE: cannot be used with "timings" and also if this is specified
- *         then you cannot override the mode in the device tree.
- * @num_modes: Number of elements in modes array.
- * @timings: Pointer to array of display timings.  NOTE: cannot be used with
- *           "modes" and also these will be used to validate a device tree
- *           override if one is present.
- * @num_timings: Number of elements in timings array.
- * @bpc: Bits per color.
- * @size: Structure containing the physical size of this panel.
- * @delay: Structure containing various delay values for this panel.
- * @bus_format: See MEDIA_BUS_FMT_... defines.
- * @bus_flags: See DRM_BUS_FLAG_... defines.
- * @connector_type: LVDS, eDP, DSI, DPI, etc.
+ * struct panel_desc - Describes a simple panel.
  */
 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 the mode.
+        * NOTE: cannot be used with "timings" and also if this is specified
+        * then you cannot override the mode in the device tree.
+        */
        const struct drm_display_mode *modes;
+
+       /** @num_modes: Number of elements in modes array. */
        unsigned int num_modes;
+
+       /**
+        * @timings: Pointer to array of display timings
+        *
+        * NOTE: cannot be used with "modes" and also these will be used to
+        * validate a device tree override if one is present.
+        */
        const struct display_timing *timings;
+
+       /** @num_timings: Number of elements in timings array. */
        unsigned int num_timings;
 
+       /** @bpc: Bits per color. */
        unsigned int bpc;
 
+       /** @size: Structure containing the physical size of this panel. */
        struct {
                /**
                 * @size.width: Width (in mm) of the active display area.
@@ -76,6 +81,7 @@ struct panel_desc {
                unsigned int height;
        } size;
 
+       /** @delay: Structure containing various delay values for this panel. */
        struct {
                /**
                 * @delay.prepare: Time for the panel to become ready.
@@ -154,8 +160,13 @@ struct panel_desc {
                unsigned int unprepare;
        } delay;
 
+       /** @bus_format: See MEDIA_BUS_FMT_... defines. */
        u32 bus_format;
+
+       /** @bus_flags: See DRM_BUS_FLAG_... defines. */
        u32 bus_flags;
+
+       /** @connector_type: LVDS, eDP, DSI, DPI, etc. */
        int connector_type;
 };