Re: [PATCH] ktime/hrtimer: fix kernel-doc comments

[Randy.Dunlap]

On Mon, 19 Jun 2006 23:00:22 +0200 Thomas Gleixner wrote:

> Randy,
> 
> On Mon, 2006-06-19 at 13:09 -0700, Randy.Dunlap wrote:
> > From: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
> > 
> > Fix kernel-doc formatting in ktime.h and hrtimer.[ch] files.
> > 
> > Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
> > ---
> >  include/linux/hrtimer.h |    3 ---
> >  include/linux/ktime.h   |    8 --------
> >  kernel/hrtimer.c        |   11 +----------
> >  3 files changed, 1 insertion(+), 21 deletions(-)
> > 
> > --- linux-2617-pv.orig/include/linux/ktime.h
> > +++ linux-2617-pv/include/linux/ktime.h
> > @@ -66,7 +66,6 @@ typedef union {
> >  
> >  /**
> >   * ktime_set - Set a ktime_t variable from a seconds/nanoseconds value
> > - *
> >   * @secs:	seconds to set
> >   * @nsecs:	nanoseconds to set
> >   *
> <.....>
> 
> Is there any real reason for doing this, expect for removing the blank
> comment lines ? 

Hm, have you looked at the kernel-doc output of those functions?

With the blank line, the function Description section (if there
is one) is duplicated.  If there is not a Description section
in the source file, then there is a (false) header generated
for it but nothing below it.

> My personal preference is to keep that line, as it makes it easier to
> read. But as always: de gustibus non est disputandum :)

Feel free to send patches for scripts/kernel-doc instead.  :)

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