On Sun, 24 Jun 2007 11:05:42 +0200, David Bourgeois <da...@ja...>
wrote:
> On Sat, 23 Jun 2007 21:52:32 +0200, neimad <ror...@gm...> wrote:
>
>> Hello,
>>
>> I started "fixing" function comments by making them use doxygen
>> syntax, and I noticed that we currently have doxygen comments using
>> both "\" and "@" styles:
>>
>> \param[in] toto Stuff
>> @param[in] titi More stuff
>>
>> I may be partly responsible for this, being accustomed to using "\" at
>> work while Tux droïd's code was using "@" (IIRC) where there were dox
>> comments (not many ;-)).
>>
>> It's not important but I like consistency, and I think we should
>> choose one or the other ("@" pleases my eyes more, but I don't really
>> mind).
>>
>> Damien
>
> I used \param in the (few documented) firmware functions so we can go
> with
> that if we're all used to it.
>
I didn't notice you already added a couple of @param, it really doesn't
matter for me which one we choose. Just go on and I'll follow.
|