Re: [AD] [patch] is_trans_font()

[ Thread Index | Date Index | More lists.liballeg.org/allegro-developers Archives ]


Doc patch attached.

--
Daniel Schlyder
Index: docs/src/allegro._tx
===================================================================
--- docs/src/allegro._tx	(revision 7543)
+++ docs/src/allegro._tx	(working copy)
@@ -6983,7 +6983,7 @@
    with them, to prevent memory leaks in your program.
 
 @@void @make_trans_font(FONT *f);
-@domain.hid set_alpha_blender, load_font, draw_trans_sprite
+@xref is_trans_font, set_alpha_blender, load_font, draw_trans_sprite
 @shortdesc Makes a font use transparency.
    This function converts a font to use transparency for drawing. That is, each
    glyph in the font will be drawn with draw_trans_sprite, so you can use the
@@ -6998,8 +6998,16 @@
    set_alpha_blender();
    textprintf_centre_ex(screen, f, 320, 240, -1, -1, "Anti-aliased Font!");<endblock>
 
+@@int @is_trans_font(FONT *f)
+@xref make_trans_font, is_color_font, is_mono_font
+@shortdesc Returns TRUE if a font uses transparency.
+   This function checks if the given font is a color font using
+   draw_trans_sprite to render glyphs.
+@retval
+   Returns TRUE if the font uses transparency, FALSE if it does not.
+
 @@int @is_color_font(FONT *f)
-@domain.hid is_mono_font
+@xref is_trans_font, is_mono_font
 @shortdesc Returns TRUE if a font is a color font.
    This function checks if the given font is a color font, as opposed to a
    monochrome font.
@@ -7007,7 +7015,7 @@
    Returns TRUE if the font is a color font, FALSE if it is not.
 
 @@int @is_mono_font(FONT *f)
-@domain.hid is_color_font
+@xref is_trans_font, is_color_font
 @shortdesc Returns TRUE if a font is a monochrome font.
    This function checks if the given font is a mono font, as opposed to a
    color font.
@@ -7015,7 +7023,7 @@
    Returns TRUE if the font is a monochrome font, FALSE if it is not.
 
 @@FONT *@is_compatible_font(FONT *f1, FONT *f2)
-@domain.hid merge_fonts, is_color_font, is_mono_font
+@xref merge_fonts, is_trans_font, is_color_font, is_mono_font
 @shortdesc Check if two fonts are of the same type.
    This function compares the two fonts, which you can use to find out if
    Allegro is capable of merging them.
@@ -7129,7 +7137,7 @@
    Returns 0 on success, -1 on failure.
 
 @@FONT *@merge_fonts(FONT *f1, FONT *f2)
-@domain.hid extract_font_range, is_color_font, is_mono_font
+@xref extract_font_range, is_trans_font, is_color_font, is_mono_font
 @eref exfont
 @shortdesc Merges two fonts into one font.
    This function merges the character ranges from two fonts and returns a new


Mail converted by MHonArc 2.6.19+ http://listengine.tuxfamily.org/