On Tue, 5 Dec 2006 13:50:17 -0800 Andrew Morton wrote:
> On Tue, 5 Dec 2006 22:27:10 +0100 (MET)
> Jan Engelhardt <[email protected]> wrote:
>
> > Someone refresh me: what's the correct[preferred] kdoc style?
>
> This isn't part of kernel-doc, if that's what you mean.
>
> > (A)
> > /* Lorem ipsum dolor sit amet, consectetur
> > * adipisicing elit, sed do eiusmod tempor
> > * incididunt ut labore et dolore magna aliqua. */
> >
> > (B)
> > /* Lorem ipsum dolor sit amet, consectetur
> > adipisicing elit, sed do eiusmod tempor
> > incididunt ut labore et dolore magna aliqua. */
> >
> > (C)
> > /* Lorem ipsum dolor sit amet, consectetur
> > adipisicing elit, sed do eiusmod tempor incididunt
> > ut labore et dolore magna aliqua. */
>
> You forgot (D), (E), (F), (G) and a whole lot more besides.
>
> It doesn't matter a lot what we do, but we should do it one way and not 38
> ways.
>
> Documentation/CodingStyle doesn't mention commenting at all (eyes roll
> heavenwards).
I have several (probably 5-6) Doc/CodingStyle changes in my WIP
(work-in-progress) folder that I will do in the next few days.
> This
>
> /*
> * Lorem ipsum dolor sit amet, consectetur
> * adipisicing elit, sed do eiusmod tempor
> * incididunt ut labore et dolore magna aliqua.
> */
>
> is probably the most common, and is what I use when forced to descrog
> comments.
---
~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]
