On 5/30/24 00:03, Jan Stary wrote:

I very much doubt anyone uses libsox at all.
In fact, I was looking for something that uses libsox today, and the only Debian packages that depend on it are sox and sox-fmt-* (!) Maybe I should use it for sound file reading, just to be the only one, but unfortunately it only delivers (and requires) 32-bit signed samples, which is a bit lumpy. I guess it wins if you want effect chains.
but libsox(3) itself says

   This manual page is both incomplete and out of date.

Is the Doxygen documentation any better?

Far more detailed/complete and less likely to get out of sync if, say, a field is added to a structure, so I guess we should check that libsox.3 is up to date, but including all the stuff in soxygen seems like a lot of work and would result in an enormously long page, and libsox.7 gives an overview of how to use it, which the doxygen output lacks. Can the doxygen stuff by amplified to include that, and can a reasonable manual page be generated out of the doxygen output?

I dunno, I also like being able to zip through structures, their fields and their types interactively rather than having to wade through header files. Maybe if the doxygen output were on the web it might attract more users.

However, for the moment let's aim at 14.2.3, making sure all CVE and other bug fixes are included, fixing any other critical bugs and making a distro-friendly release of what we have already. Then we can think about 14.3 adding functionality (backwards-compatible please!) but I don't see removing stuff as a priority unless it is a burden of some kind and I see the doxygenness of sox.h as a good idea that was never seen through to its proper conclusion.


    M

Attachment: OpenPGP_signature.asc
Description: OpenPGP digital signature

_______________________________________________
SoX-devel mailing list
SoX-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/sox-devel

Reply via email to