Re: Kernel API Reference Documentation

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

 



On Wed, 28 Jun 2006 18:13:35 +0200 Petr Tesarik wrote:

> On Wed, 2006-06-28 at 09:09 -0700, Randy.Dunlap wrote:
> > On Wed, 28 Jun 2006 14:22:53 +0200 Lukas Jelinek wrote:
> > 
> > > > I looked at
> > > > http://www.kernel-api.org/docs/online/2.6.17/da/dab/structsk__buff.html
> > > > 
> > > > and you apparently ignore kernel-doc for structs. Cf.
> > > > include/linux/skbuff.h:177 ff.
> > > 
> > > There are several problems. The one you describe is probably caused by a
> > > blank line between the struct and the related comment. Doxygen doesn't
> > > recognize it correctly (and simply ignores the comment).
> > 
> > No blank line in this case.
> 
> Oh, yes, there is a blank line between the comment and the struct. It's
> a pitty that someone put much effort into writing a usable description,
> which is then not seen. Anyway, should we find all such occurences in
> the kernel tree and fix them, or make a workaround for doxygen?

Which struct are we talking about here?  I missed it.

I guess the easy answer is Both.
However, I'm working on fixing up the kernel tree, so sending
patches is correct IMO.

---
~Randy
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

[Index of Archives]     [Kernel Newbies]     [Netfilter]     [Bugtraq]     [Photo]     [Stuff]     [Gimp]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Video 4 Linux]     [Linux for the blind]     [Linux Resources]
  Powered by Linux