Re: [Libreoffice] [PATCH] [PUSHED, partial] Some comments and basic cleanup in sc

On Tue, 2011-01-25 at 00:27 -0600, Norbert Thiebaud wrote:
> On Mon, Jan 24, 2011 at 1:24 PM, Kohei Yoshida <kyoshida@novell.com> wrote:
> > On Mon, 2011-01-24 at 18:32 +0100, Soeren Moeller wrote:
> > > Hi
> > >
> > > Thanks for pushing 0002 and 0004.
> > >
> > > In the doxygen documentation on
> > > http://www.stack.nl/~dimitri/doxygen/docblocks.html in the section
> > > "Putting documentation after members" I understand it as if the "<" is
> > > necessary to tell doxygen that the comment relates to the statement
> > > before (i.e. to the left of) the comment, instead of the statement
> > > after (i.e. in the next line), so for instance:
> > >
> > > int foo; /**< counting foos */
> > > int bar;
> > >
> > > Here doxygen relates "counting foos" as a describtion of the variable
> > > foo, while in
> > >
> > > int foo; /** counting foos */
> > > int bar;
> > >
> > > doxygen would understand "counting foo" as a describtion of the
> > > variable bar, which would be wrong (same way for ///< resp. ///), did
> > > I miss something?
> >
> > Ah...  So that tag is officially accepted by Doxygen.  Fair enough.
>
> I think that, kohei, you would probably prefer
> int foo  //!< counter of foos
>
> Which is an accepted doxygen syntax.

Well, it bothered me because of the use of '<' as a tag, which makes my
eye look for the closing '>', and upsets my mental parser when I can't
find one. ;-)

But I'll cope with it.  I'm sure I'll get used to it after seeing it
many times.

Kohei

-- 
Kohei Yoshida, LibreOffice hacker, Calc
<kyoshida@novell.com>