fluid-dev
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [fluid-dev] Some guidelines for FluidSynth development


From: josh
Subject: Re: [fluid-dev] Some guidelines for FluidSynth development
Date: Tue, 28 Apr 2009 16:42:33 -0400
User-agent: Internet Messaging Program (IMP) H3 (4.1.6)

Quoting David Henningsson <address@hidden>:
address@hidden skrev:

Doxygen comments should be put in the .c source files above the
definition which they describe, not in the headers.  A TODO item is to
move the existing documentation into the C code.

What about the public API? I assume we would have one doxygen target for
the public API and one for "everything". Will that work if we move it
into the .c file?


Yes, if I understand you correctly, the Doxygen documentation can be placed in the C file for public API functions and will still get picked up by Doxygen.



 * API: 1.1.0
 */

I suggest we use the "since" doxygen command:
@since: 1.1.0



I thought there might be something special for that, but wasn't sure what it was. Sounds good!


// David



   Josh




reply via email to

[Prev in Thread] Current Thread [Next in Thread]