[Top][All Lists]

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

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

From: David Henningsson
Subject: Re: [fluid-dev] Some guidelines for FluidSynth development
Date: Fri, 01 May 2009 09:48:05 +0200
User-agent: Thunderbird (X11/20090409)

address@hidden skrev:
> Quoting David Henningsson <address@hidden>:
>> 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 would probably look first.  The fluidsynth.h
> could just reference that file too for more info on doc generation.
> 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 auto-generated files in a source code repository.

Also I'm missing that public API reference, but that is perhaps work in
progress by Pedro?

>> To me it seems good to put:
>> @since: 1.0.9 or earlier
>> on every existing public API function? That will make it easier to see
>> what functions you can mess around with and what you have to preserve.
>> It seems to be boring work though. ;-)
> I don't think that is all that necessary.  The FluidSynth API hasn't
> changed much at all over the past years.  As long as we are good about
> marking new API, we can assume that any other API has been around for a
> while.

Well, that was just to aid the developer, to easy see which functions
belong to the public API and which functions don't, without having to go
to the .h file.

// David

reply via email to

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