Add Doxygen comments for members of the Fl_Graphics_Driver class.

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

8 files changed, 43 insertions, 11 deletions

diff --git a/src/Fl_Device.cxx b/src/Fl_Device.cxx
index 07df9d8db..dd2053f56 100644
--- a/src/Fl_Device.cxx
+++ b/src/Fl_Device.cxx
@@ -78,6 +78,7 @@ Fl_Display_Device *Fl_Display_Device::display_device() {
   return display;
 };
 
+/** Returns whether the drawing system is currently targetted to a high resolution display */
 bool Fl_Display_Device::high_resolution()
 {
   return Fl_Display_Device::display_device()->driver()->high_resolution();
diff --git a/src/Fl_Graphics_Driver.cxx b/src/Fl_Graphics_Driver.cxx
index 510852b5b..bc53ef8f8 100644
--- a/src/Fl_Graphics_Driver.cxx
+++ b/src/Fl_Graphics_Driver.cxx
@@ -22,11 +22,13 @@
 #include <FL/Fl_Image.H>
 #include <FL/fl_draw.H>
 
-FL_EXPORT Fl_Graphics_Driver *fl_graphics_driver; // the current target device of graphics operations
+FL_EXPORT Fl_Graphics_Driver *fl_graphics_driver; // the current driver of graphics operations
 
 const Fl_Graphics_Driver::matrix Fl_Graphics_Driver::m0 = {1, 0, 0, 1, 0, 0};
 
-Fl_Graphics_Driver::Fl_Graphics_Driver() {
+/** Constructor */
+Fl_Graphics_Driver::Fl_Graphics_Driver()
+{
   font_ = 0;
   size_ = 0;
   sptr=0; rstackptr=0; 
@@ -37,7 +39,7 @@ Fl_Graphics_Driver::Fl_Graphics_Driver() {
   font_descriptor_ = NULL;
 };
 
-
+/** Return the graphics driver used when drawing to the platform's display */
 Fl_Graphics_Driver &Fl_Graphics_Driver::default_driver()
 {
   static Fl_Graphics_Driver *pMainDriver = 0L;
@@ -48,7 +50,7 @@ Fl_Graphics_Driver &Fl_Graphics_Driver::default_driver()
 }
 
 
-
+/** see fl_text_extents() */
 void Fl_Graphics_Driver::text_extents(const char*t, int n, int& dx, int& dy, int& w, int& h)
 {
   w = (int)width(t, n);
@@ -57,6 +59,7 @@ void Fl_Graphics_Driver::text_extents(const char*t, int n, int& dx, int& dy, int
   dy = descent();
 }
 
+/** see fl_focus_rect() */
 void Fl_Graphics_Driver::focus_rect(int x, int y, int w, int h)
 {
   line_style(FL_DOT);
@@ -81,50 +84,54 @@ void Fl_Graphics_Driver::copy_offscreen(int x, int y, int w, int h, Fl_Offscreen
   delete[] img;
 }
 
-
+/** see fl_set_spot() */
 void Fl_Graphics_Driver::set_spot(int font, int size, int X, int Y, int W, int H, Fl_Window *win)
 {
   // nothing to do, reimplement in driver if needed
 }
 
 
+/** see fl_reset_spot() */
 void Fl_Graphics_Driver::reset_spot()
 {
   // nothing to do, reimplement in driver if needed
 }
 
 
+/** Sets the value of the fl_gc global variable when it changes */
 void Fl_Graphics_Driver::global_gc()
 {
   // nothing to do, reimplement in driver if needed
 }
 
 
-void Fl_Graphics_Driver::set_color(Fl_Color i, unsigned int c)
+/** see Fl::set_color(Fl_Color, unsigned) */
+void Fl_Graphics_Driver::set_color(Fl_Color i, unsigned c)
 {
   // nothing to do, reimplement in driver if needed
 }
 
 
+/** see Fl::free_color(Fl_Color, int) */
 void Fl_Graphics_Driver::free_color(Fl_Color i, int overlay)
 {
   // nothing to do, reimplement in driver if needed
 }
 
-
+/** Add a rectangle to an Fl_Region */
 void Fl_Graphics_Driver::add_rectangle_to_region(Fl_Region r, int x, int y, int w, int h)
 {
   // nothing to do, reimplement in driver if needed
 }
 
-
+/** Create a rectangular Fl_Region */
 Fl_Region Fl_Graphics_Driver::XRectangleRegion(int x, int y, int w, int h)
 {
   // nothing to do, reimplement in driver if needed
   return 0;
 }
 
-
+/** Delete an Fl_Region */
 void Fl_Graphics_Driver::XDestroyRegion(Fl_Region r)
 {
   // nothing to do, reimplement in driver if needed
diff --git a/src/Fl_Image_Surface.cxx b/src/Fl_Image_Surface.cxx
index 227186c26..3db192962 100644
--- a/src/Fl_Image_Surface.cxx
+++ b/src/Fl_Image_Surface.cxx
@@ -58,6 +58,7 @@ void Fl_Image_Surface::translate(int x, int y) {platform_surface->translate(x, y
 
 void Fl_Image_Surface::untranslate() {platform_surface->untranslate();}
 
+/** Returns the Fl_Offscreen object associated to the image surface */
 Fl_Offscreen Fl_Image_Surface::offscreen() {return platform_surface->offscreen;}
 
 int Fl_Image_Surface::printable_rect(int *w, int *h)  {return platform_surface->printable_rect(w, h);}
diff --git a/src/Fl_Printer.cxx b/src/Fl_Printer.cxx
index b08335500..a6756acdc 100644
--- a/src/Fl_Printer.cxx
+++ b/src/Fl_Printer.cxx
@@ -187,6 +187,11 @@ void Fl_Printer::end_job (void)
   printer->end_job();
 }
 
+/** Prints the widget on the drawing surface. 
+ \param[in] widget Any FLTK widget (e.g., standard, custom, window, GL window).
+ \param[in] delta_x,delta_y Optional offsets for positioning the widget's
+ top-left corner relatively to the current origin of graphics functions.
+ */
 void Fl_Printer::print_widget(Fl_Widget* widget, int delta_x, int delta_y)
 {
   printer->draw(widget, delta_x, delta_y);
diff --git a/src/fl_arc.cxx b/src/fl_arc.cxx
index f33d166e9..240e254de 100644
--- a/src/fl_arc.cxx
+++ b/src/fl_arc.cxx
@@ -34,6 +34,7 @@ static double _fl_hypot(double x, double y) {
   return sqrt(x*x + y*y);
 }
 
+/** see fl_arc(double x, double y, double r, double start, double end) */
 void Fl_Graphics_Driver::arc(double x, double y, double r, double start, double end) {
 
   // draw start point accurately:
diff --git a/src/fl_curve.cxx b/src/fl_curve.cxx
index 21a5f4ffb..ebe75a448 100644
--- a/src/fl_curve.cxx
+++ b/src/fl_curve.cxx
@@ -29,6 +29,7 @@
 #include <FL/fl_draw.H>
 #include <math.h>
 
+/** see fl_curve() */
 void Fl_Graphics_Driver::curve(double X0, double Y0,
 	      double X1, double Y1,
 	      double X2, double Y2,
diff --git a/src/fl_rect.cxx b/src/fl_rect.cxx
index af096d390..0b9595dae 100644
--- a/src/fl_rect.cxx
+++ b/src/fl_rect.cxx
@@ -39,11 +39,12 @@
 extern int fl_line_width_;
 
 
+/** see fl_restore_clip() */
 void Fl_Graphics_Driver::restore_clip() {
   fl_clip_state_number++;
 }
 
-
+/** see fl_clip_region(Fl_Region) */
 void Fl_Graphics_Driver::clip_region(Fl_Region r) {
   Fl_Region oldr = rstack[rstackptr];
   if (oldr) XDestroyRegion(oldr);
@@ -52,6 +53,7 @@ void Fl_Graphics_Driver::clip_region(Fl_Region r) {
 }
 
 
+/** see fl_clip_region(void) */
 Fl_Region Fl_Graphics_Driver::clip_region() {
   return rstack[rstackptr];
 }
diff --git a/src/fl_vertex.cxx b/src/fl_vertex.cxx
index e108d2163..48d9be386 100644
--- a/src/fl_vertex.cxx
+++ b/src/fl_vertex.cxx
@@ -37,7 +37,7 @@
 #include <FL/math.h>
 #include <stdlib.h>
 
-
+/** see fl_push_matrix() */
 void Fl_Graphics_Driver::push_matrix() {
   if (sptr==matrix_stack_size)
     Fl::error("fl_push_matrix(): matrix stack overflow.");
@@ -45,6 +45,7 @@ void Fl_Graphics_Driver::push_matrix() {
     stack[sptr++] = m;
 }
 
+/** see fl_pop_matrix() */
 void Fl_Graphics_Driver::pop_matrix() {
   if (sptr==0)
     Fl::error("fl_pop_matrix(): matrix stack underflow.");
@@ -52,6 +53,7 @@ void Fl_Graphics_Driver::pop_matrix() {
     m = stack[--sptr];
 }
 
+/** see fl_mult_matrix() */
 void Fl_Graphics_Driver::mult_matrix(double a, double b, double c, double d, double x, double y) {
   matrix o;
   o.a = a*m.a + b*m.c;
@@ -63,6 +65,7 @@ void Fl_Graphics_Driver::mult_matrix(double a, double b, double c, double d, dou
   m = o;
 }
 
+/** see fl_rotate() */
 void Fl_Graphics_Driver::rotate(double d) {
   if (d) {
     double s, c;
@@ -75,50 +78,61 @@ void Fl_Graphics_Driver::rotate(double d) {
   }
 }
 
+/** see fl_scale(double, double) */
 void Fl_Graphics_Driver::scale(double x, double y) {
   mult_matrix(x,0,0,y,0,0);
 }
 
+/** see fl_scale(double) */
 void Fl_Graphics_Driver::scale(double x) {
   mult_matrix(x,0,0,x,0,0);
 }
 
+/** see fl_translate() */
 void Fl_Graphics_Driver::translate(double x,double y) {
   mult_matrix(1,0,0,1,x,y);
 }
 
+/** see fl_begin_points() */
 void Fl_Graphics_Driver::begin_points() {
   n = 0;
   what = POINT_;
 }
 
+/** see fl_begin_line() */
 void Fl_Graphics_Driver::begin_line() {
   n = 0;
   what = LINE;
 }
 
+/** see fl_begin_loop() */
 void Fl_Graphics_Driver::begin_loop() {
   n = 0;
   what = LOOP;
 }
 
+/** see fl_begin_polygon() */
 void Fl_Graphics_Driver::begin_polygon() {
   n = 0;
   what = POLYGON;
 }
 
+/** see fl_transform_x() */
 double Fl_Graphics_Driver::transform_x(double x, double y) {
   return x*m.a + y*m.c + m.x;
 }
 
+/** see fl_transform_y() */
 double Fl_Graphics_Driver::transform_y(double x, double y) {
   return x*m.b + y*m.d + m.y;
 }
 
+/** see fl_transform_dx() */
 double Fl_Graphics_Driver::transform_dx(double x, double y) {
   return x*m.a + y*m.c;
 }
 
+/** see fl_transform_dy() */
 double Fl_Graphics_Driver::transform_dy(double x, double y) {
   return x*m.b + y*m.d;
 }