From 1c3163f206606070c112c8f09a758990a8f2e142 Mon Sep 17 00:00:00 2001
From: Manolo Gouy <Manolo>
Date: Thu, 12 Mar 2015 08:59:14 +0000
Subject: More detailed Doxygen doc of Fl_Shared_Image::scale() and
 Fl_Image::draw(X,Y,W,H,cx,cy).

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10618 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 FL/Fl_Image.H        | 9 ++++++---
 FL/Fl_Shared_Image.H | 2 +-
 2 files changed, 7 insertions(+), 4 deletions(-)

(limited to 'FL')

diff --git a/FL/Fl_Image.H b/FL/Fl_Image.H
index 1f1ed16bb..6890a9356 100644
--- a/FL/Fl_Image.H
+++ b/FL/Fl_Image.H
@@ -149,10 +149,13 @@ class FL_EXPORT Fl_Image {
   virtual void label(Fl_Menu_Item*m);
   /**
     Draws the image with a bounding box. 
-    This form specifies
+    Arguments <tt>X,Y,W,H</tt> specify
     a bounding box for the image, with the origin
-    (upper-lefthand corner) of the image offset by the cx
-    and cy arguments.
+    (upper-left corner) of the image offset by the \c cx
+    and \c cy arguments.\n
+   In other words:  <tt>fl_push_clip(X,Y,W,H)</tt> is applied,
+   the image is drawn with its upper-left corner at <tt>X-cx,Y-cy</tt> and its own width and height,
+   <tt>fl_pop_clip</tt><tt>()</tt> is applied.
   */
   virtual void draw(int X, int Y, int W, int H, int cx=0, int cy=0); // platform dependent
   /**
diff --git a/FL/Fl_Shared_Image.H b/FL/Fl_Shared_Image.H
index 5f96f7f2d..09bd636b2 100644
--- a/FL/Fl_Shared_Image.H
+++ b/FL/Fl_Shared_Image.H
@@ -31,7 +31,7 @@ typedef Fl_Image *(*Fl_Shared_Handler)(const char *name, uchar *header,
 
 // Shared images class. 
 /**
-  This class supports caching, loading,
+  This class supports caching, loading, scaling,
   and drawing of image files. Most applications will also want to
   link against the fltk_images library and call the
   fl_register_images()
-- 
cgit v1.2.3