On May 29 21:06:52, martinw...@gmail.com wrote:
> On 5/24/24 12:53, Jan Stary wrote:
> > Is anyone using the Doxyfile from 2011?
> > AFAICT, it can be removed without any loss.
>
> It only seems to be used in src/sox.h to document the libsox API.
>
> If you run "doxygen" in the sox root directory, it still creates
> doc/html/index.html and its friends, even though at present that seems to
> not be published anywhere on the web. Well, until now:
> http://martinwguy.net/test/soxygen
>
> The "main" page is a bit bare, but the "Classes" tab is full of stuff.
>
> There is libsox.7 too, but that lacks the structure field and enum value
> descriptions of the doxy-output, so I would suggest keeping it and putting
> its output up on the web... unless people are supposed to download the
> source tree, run doxygen themselves and browse it locally to know how to use
> libsox, which seems a bit harsh.
I very much doubt anyone uses libsox at all.
If you do, please speak up; in particular,
what do you use for the API description?
There RIght Way (^TM) is to have a libsox(3) manpage
that completely describes the API of course;
but libsox(3) itself says
This manual page is both incomplete and out of date.
and looking at the git log, it has said so since 18 years (!) ago.
Is the Doxygen documentation any better?
Jan
_______________________________________________
SoX-devel mailing list
SoX-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/sox-devel
