Re: is there a way to have a "Return:" section with a bullet list?

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

 



On Tue, 24 May 2016, Jonathan Corbet wrote:

> On Mon, 23 May 2016 15:36:31 -0400 (EDT)
> "Robert P. J. Day" <rpjday@xxxxxxxxxxxxxx> wrote:
>
> >  * Return: %0 if property with @name has been found (success),
> >  *         %-EINVAL if the arguments are invalid,
> >  *         %-EINVAL if the property doesn't exist,
> >  *         %-EPROTO if the property value type doesn't match @type.
> >  */
> >
> >   what's with those "%" symbols in the Return section? do they have
> > some special value? i don't recall those.
> >
> >   so *is* there a way to get that bullet list effect these days?
>
> % just marks a constant value - see kernel-doc-nano-howto.txt for details.

  hmmm ... i probably should have known that.

> There's no way to get a bulleted list in the kerneldoc comments -
> yet.  The Sphinx transition, assuming we pull it off, will fix
> awkward problems like that.

  that's fine, i was trying to convince someone that you couldn't do
that (yet), i just wanted to make sure i wasn't lying.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

--
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