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

2009-05-03 Thread josh
Quoting David Henningsson : j...@resonance.org skrev: 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. When I read this the first time, I thought you meant the svn

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

2009-05-03 Thread David Henningsson
j...@resonance.org skrev: > 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. When I read this the first time, I thought you meant the svn commit notes, but now I se

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

2009-05-01 Thread josh
Quoting David Henningsson : I imported the generated Doxygen docs into subversion here: https://resonance.org/svn/fluidsynth/api/index.html This will allow anyone with SVN write access to update the docs. Is that the main reason you decided to put it there? To me it does not seem right to put a

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

2009-05-01 Thread David Henningsson
j...@resonance.org skrev: > Quoting David Henningsson : >> >> I also suggest we put a comment in include/fluidsynth.h with >> instructions of how to make that doxygen target and a pointer to a >> location where it can be browsed online. > Sounds good. I added a README in doc/ with a brief mention

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

2009-05-01 Thread josh
Quoting David Henningsson : I also suggest we put a comment in include/fluidsynth.h with instructions of how to make that doxygen target and a pointer to a location where it can be browsed online. Sounds good. I added a README in doc/ with a brief mention of this same info, which is where I

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

2009-04-28 Thread David Henningsson
j...@resonance.org skrev: > Quoting David Henningsson : >> 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 >

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

2009-04-28 Thread josh
Quoting Pedro Lopez-Cabanillas : In any case, I would work on a good documentation for the public API before thinking about anything else. Totally agree. > 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 wha

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

2009-04-28 Thread Pedro Lopez-Cabanillas
On Tuesday, April 28, 2009, j...@resonance.org wrote: > Quoting David Henningsson : > > j...@resonance.org 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 int

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

2009-04-28 Thread josh
Quoting David Henningsson : j...@resonance.org 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 d

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

2009-04-27 Thread David Henningsson
j...@resonance.org 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 publ

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

2009-04-27 Thread josh
Quoting Pedro Lopez-Cabanillas : On Monday, April 27, 2009, j...@resonance.org wrote: 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 des

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

2009-04-27 Thread Pedro Lopez-Cabanillas
On Monday, April 27, 2009, j...@resonance.org wrote: > 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, > sin

[fluid-dev] Some guidelines for FluidSynth development

2009-04-27 Thread josh
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