Re: [AD] Documentation update

[Peter Wang <tjaden@xxxxxxxxxx>]

On 2005-05-03, Grzegorz Adam Hankiewicz <gradha@xxxxxxxxxx> wrote:
> Proposed patch attached.

> diff -u -r1.13 ahack._tx
> --- docs/src/ahack._tx	1 May 2005 12:28:21 -0000	1.13
> +++ docs/src/ahack._tx	3 May 2005 09:32:29 -0000
> @@ -458,7 +458,13 @@
>  accepted and merged in the WIP version for the next release. If you aren't
>  lucky, or your patch still needs some work, you will be told why it's not
>  accepted, or what you have to do to improve it. If you aren't subscribed to
> -the list, remember to tell it in your email.
> +the list, remember to tell this in your email because by default answers are
> +sent to the list.

I would say, "remember to say this in your message as, by default,
replies are directed to the list."

>  @@typedef struct @PACKFILE
>  @xref File and compression routines, pack_fopen, pack_fopen_chunk
> @@ -832,9 +850,9 @@
>  @shortdesc Packfile structure, similar to the libc FILE structure.
>     A packfile structure, similar to the libc FILE structure. Read chapter
>     "File and compression routines" for a description on how to obtain/use
> -   this structure. Note that prior to version 4.1.18, some internal fields have
> -   accidently been documented - but PACKFILE should be treated as an opaque
> -   structure, just like the libc FILE type.
> +   this structure. Note that prior to version 4.1.18, some internal fields
> +   have accidentally been documented - but PACKFILE should be treated as an

s/have/were/

> -@domain.hid *@play_audio_stream(int len, bits, stereo, freq, vol, pan);
> +You can think of an AUDIOSTREAM structure as a wrapper around two audio
> +buffers. The first thing you do is fill both buffers with sound data and let
> +Allegro play them. Once the first buffer has been played, the second starts,
> +and Allegro lets you know you have to fill the other one. The equivalent of
> +graphics double buffering applied to sounds too big to fit into memory.

"The equivalent of ..." is only a sentence fragment, so I would link it
to the previous sentence with an "i.e." or something.

Otherwise, looks great.

Peter