Re: [AD] Documentation update

[Grzegorz Adam Hankiewicz <gradha@xxxxxxxxxx>]

On 2005-06-06, Peter Wang <tjaden@xxxxxxxxxx> wrote:
> > -   after loading a sample from disk.
> > +   after loading a sample from disk. If you are creating your own samples on
> > +   the fly, you might also want to modify the raw data of the sample pointed
> > +   by the data field.
> 
> Is the sample format documented anywhere? (I didn't check)

I believe the only place is the end of play_audio_stream(). Not very
easy to spot. I would move the description from play_audio_stream
to the structure, and point in play_audio_stream() that the format
is the same as the raw data of the SAMPLE structure.

> > +   value to leave one of the settings unchanged. Values bigger than 255 will
> > +   be reduced to 255.
> 
> Do we want users to be able to rely on this?

I was about to put some asserts in the code, but since it is so
permissive, I'm just documenting the old/current behaviour.