On Mon, 2001-10-15 at 12:55, Kevin Conder wrote:
> What are your plans for documentation? I propose we could keep
> the doxygen stuff the way it is and it would be an API Reference Manual.
> Then we could create a new document that would help application
> programmers, this would be an ALSA Programmer's Guide.
>
> I've seen several requests from application developers on this
> list for simple code examples to look at. I thought the ALSA Programmer's
> Guide would step someone through the process of creating simple
> applications: WAV player, mixer, MIDI player, etc. If someone needed more
> detail, they could dive into the API Reference manual.
>
> I'd be willing to take plain text submissions for a programmer's
> guide, edit them (spelling, grammar, etc.), format them for DocBook, and
> publish it all into PDF and HTML. I've converted the ALSA mini-HOWTO to
> DocBook, so I have experience doing this.
>
>
> -- kevin at kevindumpscore dot com
>
When I read the API documentation I find whats missing the most is
definitions of what different terms mean and how they relate to one
another. The "PCM (digital audio) interface" link off of the doxygen
alsalib API "Main Page" looks like a start of what I'm talking about.
Ohh, I just realized that this is what Jaraslav just created. Looks
good.
On another note, some pages seem to be awefully long (the group_pcm.html
page for instance). Is it possible to split things like this with
doxygen?
--
Josh Green
Smurf Sound Font Editor (http://smurf.sourceforge.net)
_______________________________________________
Alsa-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/alsa-devel
