[Top][All Lists]

[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: Fri, 01 May 2009 03:09:38 -0400
User-agent: Internet Messaging Program (IMP) H3 (4.1.6)

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:

This will allow anyone with SVN write access to update the docs. Also linked it from the FluidSynth documentation Wiki page. One thing to note is I had to set the SVN mime-type properties of the .html (text/html), .png (image/png) and .gif (image/gif) files in order for it to be browse-able directly through subversion (shows contents of .html files otherwise), when checking in new files, they will also need to have their mime types set. I suppose another option would be to add a periodic SVN checkout to a friendlier web environment.

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.

// David



reply via email to

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