Re: [AD] First batch of doc changes

[Grzegorz Adam Hankiewicz <gradha@xxxxxxxxxx>]

On 2005-06-05, Evert Glebbeek <eglebbk@xxxxxxxxxx> wrote:
> +@@Macro @AL_ID(a,b,c,d)
> +@shortdesc Converts four 8 bit values to a packed 32 bit integer ID.
> +@xref DAT_ID
> +   This macro can be used to create a packed 32 bit integer from 8 bit
> +   characters. Example:

It would be nice to hear too what these 32 bit packed integers might
be useful too, even if it is a vague sentence like "These IDs can
be useful to create custom datafile objects for your game". Also,
any note on what happens to 64 bit systems, if anything at all.

> +   when running in a DOS box under Windows. Example:
> +<codeblock>
> +   set_window_title("Allegro rules!");<endblock>

Identation.

>     Also note that the supplied callback is also called under MacOS X when
>     the user hits Command-Q or selects "Quit" from the application menu.
> +   Example:
> +<codeblock>
> +      #include <allegro.h>
> +      volatile int close_button_pressed = FALSE;

Since documentation examples don't try to be complete copy&paste
examples, you can avoid the include to reduce lines of text.

> +      int main(void)
> +      {
> +         allegro_init();
> +         LOCK_FUNCTION(close_button_handler);

Also no need to show main(). Just the identation is enough to
compare against the previous lines that the code here is part of
"some" function. Which allows you to chop off 4 lines more.