Re: [AD] Documentation update

[Peter Wang <tjaden@xxxxxxxxxx>]

Grzegorz Adam Hankiewicz wrote:

> Attached proposed documentation update.
>  
+@@Macro @LOCK_FUNCTION(function_name);
+@xref install_int, install_int_ex
+@eref exscn3d, exsprite, exswitch, extimer, exupdate, exzbuf
+@shortdesc Locks the memory of a function used by a timer.
+   Due to interrupts/threading, you are required to lock all the memory 
used
+   by your timer routines. See the description of install_int_ex() for a
+   more detailed explanation and usage example.
+  

I would get rid of the 'threading' part.  LOCK_FUNCTION doesn't help 
with that.


@@int @is_color_font(FONT *f)
@xref is_mono_font
@shortdesc Returns TRUE if a font is a color font.
   This function returns TRUE if the font is an Allegro color font (as
   opposed to a monochrome font).
-@domain.hid
-   Returns TRUE if the font is a color font, FALSE if it is not.

Instead of removing the @retval section, what about rewording the 
description to be like:

   This function checks if the given font is a color font, as opposed 
to a monochrome font.


Otherwise, looks fine.

Peter