| Message ID | 1430267884-20560-2-git-send-email-laurent.pinchart+renesas@ideasonboard.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
Hello. On 4/29/2015 3:37 AM, Laurent Pinchart wrote: > Document the structure fields using kerneldoc. > Signed-off-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com> > --- > drivers/gpu/drm/rcar-du/rcar_du_crtc.h | 14 ++++++++++++++ > 1 file changed, 14 insertions(+) > > diff --git a/drivers/gpu/drm/rcar-du/rcar_du_crtc.h b/drivers/gpu/drm/rcar-du/rcar_du_crtc.h > index 5d9aa9b33769..e72f15c8c706 100644 > --- a/drivers/gpu/drm/rcar-du/rcar_du_crtc.h > +++ b/drivers/gpu/drm/rcar-du/rcar_du_crtc.h > @@ -22,6 +22,20 @@ > > struct rcar_du_group; > > +/* Kerneldoc needs /** at the start of comment. > + * rcar_du_crtc - the CRTC, representing a DU superposition processor Kerneldoc needs *struct* before the name. [...] WBR, Sergei
Hi Sergei, Thank you for the review. On Wednesday 29 April 2015 14:33:31 Sergei Shtylyov wrote: > On 4/29/2015 3:37 AM, Laurent Pinchart wrote: > > Document the structure fields using kerneldoc. > > > > Signed-off-by: Laurent Pinchart > > <laurent.pinchart+renesas@ideasonboard.com> > > --- > > > > drivers/gpu/drm/rcar-du/rcar_du_crtc.h | 14 ++++++++++++++ > > 1 file changed, 14 insertions(+) > > > > diff --git a/drivers/gpu/drm/rcar-du/rcar_du_crtc.h > > b/drivers/gpu/drm/rcar-du/rcar_du_crtc.h index 5d9aa9b33769..e72f15c8c706 > > 100644 > > --- a/drivers/gpu/drm/rcar-du/rcar_du_crtc.h > > +++ b/drivers/gpu/drm/rcar-du/rcar_du_crtc.h > > @@ -22,6 +22,20 @@ > > > > struct rcar_du_group; > > > > +/* > > Kerneldoc needs /** at the start of comment. I have mixed feelings about that when documenting a driver, as generating documentation for the driver internals might not be very useful. On the other hand, the kernel documentation generation process doesn't include drivers randomly, so I suppose it can't hurt. I'll change it. > > + * rcar_du_crtc - the CRTC, representing a DU superposition processor > > Kerneldoc needs *struct* before the name. Oops, my bad, I'll fix that. Same for patch 02/10.
diff --git a/drivers/gpu/drm/rcar-du/rcar_du_crtc.h b/drivers/gpu/drm/rcar-du/rcar_du_crtc.h index 5d9aa9b33769..e72f15c8c706 100644 --- a/drivers/gpu/drm/rcar-du/rcar_du_crtc.h +++ b/drivers/gpu/drm/rcar-du/rcar_du_crtc.h @@ -22,6 +22,20 @@ struct rcar_du_group; +/* + * rcar_du_crtc - the CRTC, representing a DU superposition processor + * @crtc: base DRM CRTC + * @clock: the CRTC functional clock + * @extclock: external pixel dot clock (optional) + * @mmio_offset: offset of the CRTC registers in the DU MMIO block + * @index: CRTC software and hardware index + * @started: whether the CRTC has been started and is running + * @event: event to post when the pending page flip completes + * @flip_wait: wait queue used to signal page flip completion + * @outputs: bitmask of the outputs (enum rcar_du_output) driven by this CRTC + * @enabled: whether the CRTC is enabled, used to control system resume + * @group: CRTC group this CRTC belongs to + */ struct rcar_du_crtc { struct drm_crtc crtc;
Document the structure fields using kerneldoc. Signed-off-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com> --- drivers/gpu/drm/rcar-du/rcar_du_crtc.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+)