Re: [PATCH 01/10] drm: rcar-du: Document the rcar_du_crtc structure

[Laurent Pinchart <laurent.pinchart@ideasonboard.com>]

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.

-- 
Regards,

Laurent Pinchart