Paul Davis wrote: > > The equivalent documentation (i.e. the list of functions with > descriptions) exists in the source and can be generated with
Description is usually just non-shortened version of function name, but doesn't tell much about functional relations and what it exactly does. Doxygen is able to create useful relation graphs, at least from C++ source. Anyway, I like doxygen and I think it's great to use it for documentation. But developers should try to write more than one sentence about functions. Usage and function relations are of course obvious for alsa-lib developers, but not for people trying to move to alsa 0.9 from 0.5 or OSS. Example: "name ASCII identifier of the PCM handle" What should be format for this indentifier? Something like 0.5 "0:0:0"? Links to struct parameter types should link to useful struct explanation. > doxygen. It is not currently available online. There has been some > discussion here on getting it up and accessible that way. Seems to be now... > There are no tutorial or "explanatory" documents at this time, AFAIK. I like the OSS documentation. It doesn't tell everything either, but it's rather good. - Jussi Laako -- PGP key fingerprint: 161D 6FED 6A92 39E2 EB5B 39DD A4DE 63EB C216 1E4B Available at PGP keyservers _______________________________________________ Alsa-devel mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/alsa-devel
