Re: [PATCH v3 1/2] Documentation/sphinx: allow "functions" with no parameters

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sat, Jun 30, 2018 at 04:21:56AM -0700, Matthew Wilcox wrote:
> On Sat, Jun 30, 2018 at 12:05:10AM +0300, Mike Rapoport wrote:
> > @@ -488,14 +488,19 @@ doc: *title*
> >      .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
> >         :doc: High Definition Audio over HDMI and Display Port
> >  
> > -functions: *function* *[...]*
> > +functions: *[ function ...]*
> >    Include documentation for each *function* in *source*.
> > +  If no *function* if specified, the documentaion for all functions
> 
> "is specified".  "documentation".
> 
> > -  Example::
> > +  Examples::
> >  
> >      .. kernel-doc:: lib/bitmap.c
> >         :functions: bitmap_parselist bitmap_parselist_user
> >  
> > +    .. kernel-doc:: lib/idr.c
> > +       :functions:
> 
> Is this the right syntax?  Should we rather have:
> 
>     .. kernel-doc:: lib/idr.c
>        :functions: *

IMHO :functions: with no parameters is simpler.
 

-- 
Sincerely yours,
Mike.

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux