Rockbox mail archive
Subject: Re: Plugin API documentation
Re: Plugin API documentation
On Tue, Jan 13, 2009 at 18:39, Dominik Riebeling <
> That's pretty much like doxygen comments work, which would look like
> this (given that the AUTOBRIEF option is turned on, otherwise you'd
> need an additional @brief in the first line):
> /** short description of the function.
> * optional longer description of the function
> * @param arg1 description of arg1
> * @param arg2 description of arg2
> * @return description of return valus
> So I'd suggest when refactoring also moving to that syntax -- you
> could still use your generator, or optionally run doxygen on it. There
> are also groups (though I don't remember off the top of my head how
> that tag was). As a side note, doxygen also understands tags with
> leading \ instead of @ so that could also get used. I, however, prefer
> the latter.
I don't have any problems with that, but does Doxygen ignore unsupported
Like for example when you have something like:
/** short description of the function.
* optional longer description of the function
* @param arg1 description of arg1
* @param arg2 description of arg2
* @return description of return valus
* @see [W[RockboxKernel]]
And does Doxygen has a feature where only 1 type of description can get
used? I don't see any use for adding both a short and long description, IMO
one (long) description suffices.
Received on 2009-01-13
Page was last modified "Jan 10 2012" The Rockbox Crew