Re: [RFC V1] lib: cordic: add library module for cordic anglecalculation

[Randy Dunlap]

On Thu, 26 May 2011 10:09:24 +0200 Arend van Spriel wrote:

> On 05/25/2011 10:04 PM, Randy Dunlap wrote:
> > On Wed, 25 May 2011 21:40:26 +0200 Arend van Spriel wrote:
> >> +/**
> >> + * struct - i/q coordinate.
> >   * struct cordic_iq - i/q coordinate
> 
> The kernel-doc processing is pretty smart here. In the current form I 
> get the html as attached. From that perspective your proposed change is 
> not needed, but if your point is that it would be more clear to the mere 
> mortal reading through the source code I can change it.

Hm, I see.  scripts/kernel-doc gets the struct name from the source code
in this case.  too smart ;)

AFAIK, everywhere else we use

/**
 * struct structname - description

and that's what Documentation/kernel-doc-nano-HOWTO.txt calls for, and
yes, it would be more readable to us mortals also, so please change it.

thanks,
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
--
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/