Looking at the recent commits, I thought it would be good to mention
some general guidelines.
Please make use of the ChangeLog. Change details don't have to be
incredibly detailed and in fact more general descriptions are better,
since the details are in the code itself.
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.
We need to come up with some standard way to indicate in Doxygen
documentation that an API is from a specific version of FluidSynth and
make use of it. Perhaps something like:
/**
* Create a new file renderer and open the file.
* @param synth The synth that creates audio data.
* @param filename Output filename
* @param period_size Sample count, amount of samples to write to the file at
* every call to fluid_file_renderer_process_block().
* @return the new object, or NULL on failure
*
* Optional more descriptive message here..
*
* API: 1.1.0
*/
Can't think of anything else at the moment. Great to see the sample
renderer and player code committed. Some nice new functionality which
I should actually start using :)
Josh
_______________________________________________
fluid-dev mailing list
fluid-dev@nongnu.org
http://lists.nongnu.org/mailman/listinfo/fluid-dev
