[Intel-gfx] [PATCH 02/11] drm/doc: Add kerneldoc for @index

[Daniel Vetter]

On Fri, Jul 15, 2016 at 09:06:04PM +0100, Chris Wilson wrote:
> On Fri, Jul 15, 2016 at 09:47:59PM +0200, Daniel Vetter wrote:
> > Was forgotten when adding them all over. 0-day should complain about
> > new missing kernel-doc, not sure why that wasn't caught/fixed.
> > 
> > Cc: Chris Wilson <chris at chris-wilson.co.uk>
> > Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>
> > ---
> >  include/drm/drm_crtc.h | 26 +++++++++++++++++++++-----
> >  1 file changed, 21 insertions(+), 5 deletions(-)
> > 
> > diff --git a/include/drm/drm_crtc.h b/include/drm/drm_crtc.h
> > index ebf078685f86..656f189f1198 100644
> > --- a/include/drm/drm_crtc.h
> > +++ b/include/drm/drm_crtc.h
> > @@ -783,7 +783,10 @@ struct drm_crtc {
> >  	struct drm_plane *primary;
> >  	struct drm_plane *cursor;
> >  
> > -	/* position inside the mode_config.list, can be used as a [] idx */
> > +	/**
> > +	 * @index: Position inside the mode_config.list, can be used as an array
> 
> For all:
> 
> @index: Fixed position inside the mode_config.list, can be used as an
> array index. The @index is assigned when the crtc is inserted into the
> list, and it will remain at that position inside the list until the
> module is unloaded.
> 
> Just want to emphasis the unchanging nature of the @index. Second
> sentence may be overkill.

Just adding "It is invariant over the lifetime of $object." for brevity?
-Daniel
-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch