Re: kernel-doc problem

[Johannes Berg <johannes@sipsolutions.net>]

On Thu, 2010-08-19 at 08:30 -0700, Randy Dunlap wrote:

> > --- here's the file ---
> > /**
> >  * fn - test
> >  *
> >  * @a: This is just a non-sense and totally useless dummy function
> >  *	argument: it has absolutely no effect.
> >  */
> > void fn(int a)
> > {
> > }
> 
> Colons (':') are bad.  They cause a section instance.

Yeah, that's what I found.

> I don't know how to fix it (inside kernel-doc or docproc or xmlto or wherever).
> Sometimes I change colon to "--" or "." or something that makes some sense,
> but colon is still the better choice if it would work.

Ok.

Actually, I can think of something. When we have a line that starts with
this kind of pattern, assume that the next line is a continuation of it
and do not pattern match it, unless there was a blank line. I guess that
needs a special case for @...: though.

johannes