Completed Doxygen documentation of Fl_Device, Fl_Abstract_Printer, Fl_Printer classes.

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

1 files changed, 77 insertions, 5 deletions

diff --git a/FL/Fl_Device.H b/FL/Fl_Device.H
index 237d6b5b9..00e6a4768 100644
--- a/FL/Fl_Device.H
+++ b/FL/Fl_Device.H
@@ -49,12 +49,23 @@ extern Fl_Display *fl_display_device;
 typedef void (*Fl_Draw_Image_Cb)(void* ,int,int,int,uchar*);
 
 /**
- @brief A pure virtual class subclassed to send graphics output to display, local files, or printers.
+ \brief A pure virtual class subclassed to send the output of drawing functions to display, printers, or local files.
+ *
+ The protected virtual methods of this class are those that a device should implement to
+ support all of FLTK drawing functions.
+ <br> The preferred FLTK API for drawing operations is the function collection of the 
+ \ref fl_drawings and \ref fl_attributes modules. 
+ <br> Alternatively, member functions of the Fl_Device class can be called
+ using global variable Fl_Device *fl_device that points at all time to the single device 
+ (an instance of an Fl_Device subclass) that's currently receiving drawing requests:<br>
+ <tt>fl_device->rect(x, y, w, h);</tt>
  */
 class Fl_Device {
 protected:
-  int type_;
-  uchar bg_r_, bg_g_, bg_b_; // color for background and/or mixing if particular device does not support masking and/or alpha
+  /** \brief The device type */
+  int type_; 
+  /** \brief color for background and/or mixing if device does not support masking or alpha */
+  uchar bg_r_, bg_g_, bg_b_; 
   friend void fl_rect(int x, int y, int w, int h);
   friend void fl_rectf(int x, int y, int w, int h);
   friend void fl_line_style(int style, int width, char* dashes);
@@ -76,8 +87,6 @@ protected:
   friend void fl_loop(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3);
   friend void fl_polygon(int x0, int y0, int x1, int y1, int x2, int y2);
   friend void fl_polygon(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3);
-  friend void fl_concat();
-  friend void fl_reconcat();
   friend void fl_begin_points();
   friend void fl_begin_line();
   friend void fl_begin_loop();
@@ -106,58 +115,121 @@ protected:
   friend void fl_draw_image(Fl_Draw_Image_Cb, void*, int,int,int,int, int delta);
   friend void fl_draw_image_mono(Fl_Draw_Image_Cb, void*, int,int,int,int, int delta);
   
+  /** \brief see fl_rect(int x, int y, int w, int h). */
   virtual void rect(int x, int y, int w, int h);
+  /** \brief see fl_rectf(int x, int y, int w, int h). */
   virtual void rectf(int x, int y, int w, int h);
+  /** \brief see fl_line_style(int style, int width, char* dashes). */
   virtual void line_style(int style, int width=0, char* dashes=0);
+  /** \brief see fl_xyline(int x, int y, int x1). */
   virtual void xyline(int x, int y, int x1);
+  /** \brief see fl_xyline(int x, int y, int x1, int y2). */
   virtual void xyline(int x, int y, int x1, int y2);
+  /** \brief see fl_xyline(int x, int y, int x1, int y2, int x3). */
   virtual void xyline(int x, int y, int x1, int y2, int x3);
+  /** \brief see fl_yxline(int x, int y, int y1). */
   virtual void yxline(int x, int y, int y1);
+  /** \brief see fl_yxline(int x, int y, int y1, int x2). */
   virtual void yxline(int x, int y, int y1, int x2);
+  /** \brief see fl_yxline(int x, int y, int y1, int x2, int y3). */
   virtual void yxline(int x, int y, int y1, int x2, int y3);
+  /** \brief see fl_line(int x, int y, int x1, int y1). */
   virtual void line(int x, int y, int x1, int y1);
+  /** \brief see fl_line(int x, int y, int x1, int y1, int x2, int y2). */
   virtual void line(int x, int y, int x1, int y1, int x2, int y2);
+  /** \brief see fl_draw(const char *str, int n, int x, int y). */
   virtual void draw(const char *str, int n, int x, int y);
+  /** \brief see fl_draw(int angle, const char *str, int n, int x, int y). */
   virtual void draw(int angle, const char *str, int n, int x, int y);
+  /** \brief see fl_font(Fl_Font face, Fl_Fontsize size). */
   virtual void font(Fl_Font face, Fl_Fontsize size);
+  /** \brief see fl_color(Fl_Color c). */
   virtual void color(Fl_Color c);
+  /** \brief see fl_color(uchar r, uchar g, uchar b). */
   virtual void color(uchar r, uchar g, uchar b);
+  /** \brief see fl_point(int x, int y). */
   virtual void point(int x, int y);
+  /** \brief see fl_loop(int x0, int y0, int x1, int y1, int x2, int y2). */
   virtual void loop(int x0, int y0, int x1, int y1, int x2, int y2);
+  /** \brief see fl_loop(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3). */
   virtual void loop(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3);
+  /** \brief see fl_polygon(int x0, int y0, int x1, int y1, int x2, int y2). */
   virtual void polygon(int x0, int y0, int x1, int y1, int x2, int y2);
+  /** \brief see fl_polygon(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3). */
   virtual void polygon(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3);
+  /** \brief see fl_begin_points(). */
   virtual void begin_points();
+  /** \brief see fl_begin_line(). */
   virtual void begin_line();
+  /** \brief see fl_begin_loop(). */
   virtual void begin_loop();
+  /** \brief see fl_begin_polygon(). */
   virtual void begin_polygon();
+  /** \brief see fl_vertex(double x, double y). */
   virtual void vertex(double x, double y);
+  /** \brief see fl_curve(double x, double y, double x1, double y1, double x2, double y2, double x3, double y3). */
   virtual void curve(double x, double y, double x1, double y1, double x2, double y2, double x3, double y3);
+  /** \brief see fl_circle(double x, double y, double r). */
   virtual void circle(double x, double y, double r);
+  /** \brief see fl_arc(double x, double y, double r, double start, double a). */
   virtual void arc(double x, double y, double r, double start, double a);
+  /** \brief see fl_arc(int x, int y, int w, int h, double a1, double a2). */
   virtual void arc(int x, int y, int w, int h, double a1, double a2);
+  /** \brief see fl_pie(int x, int y, int w, int h, double a1, double a2). */
   virtual void pie(int x, int y, int w, int h, double a1, double a2);
+  /** \brief see fl_end_points(). */
   virtual void end_points();
+  /** \brief see fl_end_line(). */
   virtual void end_line();
+  /** \brief see fl_end_loop(). */
   virtual void end_loop();
+  /** \brief see fl_end_polygon(). */
   virtual void end_polygon();
+  /** \brief see fl_begin_complex_polygon(). */
   virtual void begin_complex_polygon();
+  /** \brief see fl_gap(). */
   virtual void gap();
+  /** \brief see fl_end_complex_polygon(). */
   virtual void end_complex_polygon();
+  /** \brief see fl_transformed_vertex(double x, double y). */
   virtual void transformed_vertex(double x, double y);
+  /** \brief see fl_push_clip(int x, int y, int w, int h). */
   virtual void push_clip(int x, int y, int w, int h);
+  /** \brief see fl_clip_box(int x, int y, int w, int h, int &X, int &Y, int &W, int &H). */
   virtual int clip_box(int x, int y, int w, int h, int &X, int &Y, int &W, int &H);
+  /** \brief see fl_not_clipped(int x, int y, int w, int h). */
   virtual int not_clipped(int x, int y, int w, int h);
+  /** \brief see fl_push_no_clip(). */
   virtual void push_no_clip();
+  /** \brief see fl_pop_clip(). */
   virtual void pop_clip();
   // Images
+  /** \brief see fl_draw_image(const uchar*, int,int,int,int, int delta, int ldelta). */
   virtual   void draw_image(const uchar*, int,int,int,int, int delta=3, int ldelta=0);
+  /** \brief see fl_draw_image_mono(const uchar*, int,int,int,int, int delta, int ldelta). */
   virtual   void draw_image_mono(const uchar*, int,int,int,int, int delta=1, int ld=0);
+  /** \brief see fl_draw_image(Fl_Draw_Image_Cb, void*, int,int,int,int, int delta). */
   virtual   void draw_image(Fl_Draw_Image_Cb, void*, int,int,int,int, int delta=3);
+  /** \brief see fl_draw_image_mono(Fl_Draw_Image_Cb, void*, int,int,int,int, int delta). */
   virtual   void draw_image_mono(Fl_Draw_Image_Cb, void*, int,int,int,int, int delta=1);
   // Image classes
+  /** \brief Draws an Fl_Pixmap object to the device. 
+   *
+   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_RGB_Image object to the device. 
+   *
+   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_Bitmap object to the device. 
+   *
+   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 * bmp,int XP, int YP, int WP, int HP, int cx, int cy);
   
 public: