From 9a7185384a27e67352144b1a0c392ab2191ce527 Mon Sep 17 00:00:00 2001
From: engelsman <engelsman>
Date: Sun, 15 Mar 2009 11:27:56 +0000
Subject: doxygen comments for fl_draw_image(), fl_latin1_to_local() and
 friends

updated FL/fl_draw.H to avoid triplication in src/fl_draw_image*.cxx
and duplication in src/fl_encoding_latin1.cxx
rationalized some parameter names to match existing docs

updated documentation/src/drawing.dox to have section headers in order
and to enable paragraph tags to link to fl_draw_image*()
(can't work out how to link Fl_Draw_Image_Cb as paragraph tag :-( )



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6688 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 documentation/src/drawing.dox | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

(limited to 'documentation/src')

diff --git a/documentation/src/drawing.dox b/documentation/src/drawing.dox
index 76f24584e..4596c1a42 100644
--- a/documentation/src/drawing.dox
+++ b/documentation/src/drawing.dox
@@ -36,8 +36,13 @@ header file. FLTK provides the following types of drawing functions:
 \li \ref ssect_Fast
 \li \ref ssect_Complex
 \li \ref ssect_Text
-\li \ref ssect_Fl_Image
+\li \ref ssect_Fonts
+\li \ref ssect_CharacterEncoding
 \li \ref ssect_Overlay
+\li \ref drawing_images
+\li \ref ssect_DirectImageDrawing
+\li \ref ssect_DirectImageReading
+\li \ref ssect_Fl_Image
 \li \ref ssect_Offscreen
 
 <A name="boxdraw"></A> <!-- For old HTML links only ! -->
@@ -735,10 +740,8 @@ transformation matrix is not the identity is not defined, so you
 should only draw images when the matrix is set to the identity.
 
 <A NAME="fl_draw_image"></A> <!-- For old HTML links only ! -->
-void fl_draw_image(const uchar *, int X, int Y, int W, int H,
-int D = 3, int LD = 0) <br>
-void fl_draw_image_mono(const uchar *, int X, int Y, int W, int H,
-int D = 1, int LD = 0)
+void fl_draw_image(const uchar *buf,int X,int Y,int W,int H,int D,int L)<br>
+void fl_draw_image_mono(const uchar *buf,int X,int Y,int W,int H,int D,int L)
 
 \par
 Draw an 8-bit per color RGB or luminance image.  The pointer
@@ -748,7 +751,7 @@ put the top-left corner. <tt>W</tt> and <tt>H</tt> define the
 size of the image. <tt>D</tt> is the delta to add to the pointer
 between pixels, it may be any value greater or equal to
 <tt>3</tt>, or it can be negative to flip the image
-horizontally. <tt>LD</tt> is the delta to add to the pointer
+horizontally. <tt>L</tt> is the delta to add to the pointer
 between lines (if 0 is passed it uses <tt>W * D</tt>), and may
 be larger than <tt>W * D</tt> to crop data, or negative to flip
 the image vertically.
@@ -778,11 +781,9 @@ If FLTK cannot draw the image in the current visual it
 will abort. FLTK supports any visual of 8 bits or less,
 and all common TrueColor visuals up to 32 bits.
 
-typedef void (*fl_draw_image_cb)(void *, int x, int y, int w, uchar *) <br>
-void fl_draw_image(fl_draw_image_cb, void *, int X, int Y, int W, int H,
-int D = 3) <br>
-void fl_draw_image_mono(fl_draw_image_cb, void *, int X, int Y, int W, int H,
-int D = 1)
+typedef void (*Fl_Draw_Image_Cb)(void *data,int x,int y,int w,uchar *buf) <br>
+void fl_draw_image(Fl_Draw_Image_Cb cb,void *data,int X,int Y,int W,int H,int D) <br>
+void fl_draw_image_mono(Fl_Draw_Image_Cb cb,void *data,int X,int Y,int W,int H,int D)
 
 \par
 Call the passed function to provide each scan line of the
-- 
cgit v1.2.3