On Mon, 2001-10-01 at 18:22, John Gluck wrote:
> Hi
>
> Sadly, I have come to the conclusion that there is exactly zip in the
> way of docs.
> I wonder how it was designed without at least a bit of documentation on
> what everything does.
> Even if the original design stuff is incomplete at least it gives some
> idea of what the architeature and API are about.
>
> It will be hard to get wide acceptance without some documentation. With
> a bit of guidance as to the API, I wouldn't mind doing some doc as a web
> page.
>
> I'm printing out the source of alsamixer which seems to have at least a
> few comments. Guess I'll start there.
>
> If someone wants to work with me on this please let me know.
>
> John
>
I take it you didn't check out the docbook based documentation. Just:
1. download and extract 0.9.0beta alsa-lib (or get it via CVS)
2. "cd doc"
3. "make doc" (make sure you have doxygen installed)
4. point browser to doc/doxygen/html/index.html
The ALSA API does seem to be fairly well documented, although there
aren't any nice little examples with the doxygen stuff.
The rather detailed instructions weren't meant to be insulting, more as
step by step instructions for others who want documentation too, as
right now its not too accessible.
*** DOXYGEN API STUFF SHOULD BE ON ALSA WEB SITE!! ***
Why not a cron job somewhere that updates alsa-lib CVS in a directory
and then runs doxygen, archiving old documentation for download and
installing new for online browsing.. I will set this up if the ALSA
webmaster wont.. Take that as a warning :) I'm sure you all are getting
tired of hearing people ask why there isn't any API documentation. Why
let all that nice information go to waste?
--
Josh Green
Smurf Sound Font Editor (http://smurf.sourceforge.net)
_______________________________________________
Alsa-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/alsa-devel
