Improve Doxygen comments related to image drawing

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12407 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

3 files changed, 11 insertions, 9 deletions

diff --git a/FL/Fl_Graphics_Driver.H b/FL/Fl_Graphics_Driver.H
index ffb6c8408..1a45d375f 100644
--- a/FL/Fl_Graphics_Driver.H
+++ b/FL/Fl_Graphics_Driver.H
@@ -148,25 +148,25 @@ protected:
   virtual void draw_image(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D=3) {}
   /** see fl_draw_image_mono(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D) */
   virtual void draw_image_mono(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D=1) {}
-  /** \brief Draws an Fl_RGB_Image object to the device.
+  /** \brief Draws an Fl_RGB_Image object using this graphics driver.
    *
    Specifies a bounding box for the image, with the origin (upper left-hand corner) of
    the image offset by the cx and cy arguments.
    */
   virtual void draw(Fl_RGB_Image * rgb,int XP, int YP, int WP, int HP, int cx, int cy) {}
-  /** \brief Draws an Fl_Pixmap object to the device.
+  /** \brief Draws an Fl_Pixmap object using this graphics driver.
    *
    Specifies a bounding box for the image, with the origin (upper left-hand corner) of
    the image offset by the cx and cy arguments.
    */
   virtual void draw(Fl_Pixmap * pxm,int XP, int YP, int WP, int HP, int cx, int cy) {}
-  /** \brief Draws an Fl_Bitmap object to the device.
+  /** \brief Draws an Fl_Bitmap object using this graphics driver.
    *
    Specifies a bounding box for the image, with the origin (upper left-hand corner) of
    the image offset by the cx and cy arguments.
    */
   virtual void draw(Fl_Bitmap *bm, int XP, int YP, int WP, int HP, int cx, int cy) {}
-  virtual void draw(Fl_Shared_Image *img, int x, int y);
+  virtual void draw(Fl_Shared_Image *shared, int X, int Y);
   virtual int draw_scaled(Fl_Image *img, int X, int Y, int W, int H);
   virtual void copy_offscreen(int x, int y, int w, int h, Fl_Offscreen pixmap, int srcx, int srcy);
 
@@ -423,7 +423,7 @@ protected:
   virtual void draw_unscaled(Fl_Bitmap *bm, float s, int XP, int YP, int WP, int HP, int cx, int cy)=0;
   virtual void draw(Fl_RGB_Image *img, int XP, int YP, int WP, int HP, int cx, int cy);
   virtual void draw_unscaled(Fl_RGB_Image *img, float s, int XP, int YP, int WP, int HP, int cx, int cy)=0;
-  void draw(Fl_Shared_Image *shared, int X, int Y);
+  virtual void draw(Fl_Shared_Image *shared, int X, int Y);
   virtual void point(int x, int y);
   virtual void point_unscaled(float x, float y) = 0;
   virtual void rect(int x, int y, int w, int h);
diff --git a/FL/Fl_Image.H b/FL/Fl_Image.H
index 83e76cbd0..3f0ab6fa7 100644
--- a/FL/Fl_Image.H
+++ b/FL/Fl_Image.H
@@ -164,7 +164,7 @@ public:
   virtual void label(Fl_Widget*w);
   virtual void label(Fl_Menu_Item*m);
   /**
-   Draws the image with a bounding box.
+   Draws the image to the current drawing surface with a bounding box.
    Arguments <tt>X,Y,W,H</tt> specify
    a bounding box for the image, with the origin        
    (upper-left corner) of the image offset by the \c cx
@@ -176,8 +176,8 @@ public:
    */
   virtual void draw(int X, int Y, int W, int H, int cx=0, int cy=0); // platform dependent
   /**
-   Draws the image.
-   This form specifies the upper-lefthand corner of the image.
+   Draws the image to the current drawing surface.
+   \param X, Y specify the upper-lefthand corner of the image.
    */
   void draw(int X, int Y) {draw(X, Y, w(), h(), 0, 0);} // platform dependent
   virtual void uncache();
diff --git a/src/Fl_Shared_Image.cxx b/src/Fl_Shared_Image.cxx
index f9052c852..a6783faa6 100644
--- a/src/Fl_Shared_Image.cxx
+++ b/src/Fl_Shared_Image.cxx
@@ -372,7 +372,9 @@ void Fl_Shared_Image::draw(int X, int Y, int W, int H, int cx, int cy) {
   if (need_clip) fl_pop_clip();
 }
 
-/** Draws the shared image to the current surface with its top-left at X,Y */
+/** Draws an Fl_Shared_Image object using this graphics driver.
+ \param shared shared image to be drawn
+ \param X,Y top-left position of the drawn image */
 void Fl_Graphics_Driver::draw(Fl_Shared_Image *shared, int X, int Y) {
   if ( shared->w() == shared->image_->w() && shared->h() == shared->image_->h()) {
     shared->image_->draw(X, Y, shared->w(), shared->h(), 0, 0);