doxygen comments for undocumented drawing, clipping and color functions

added comments in fl_draw.H, fl_color.cxx and fl_rect.cxx so that the
links within drawing.dox can be simplified to allow LaTeX/PDF docs too.



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

1 files changed, 12 insertions, 2 deletions

diff --git a/FL/fl_draw.H b/FL/fl_draw.H
index 5bc370fe0..94f5b5668 100644
--- a/FL/fl_draw.H
+++ b/FL/fl_draw.H
@@ -25,6 +25,11 @@
 //     http://www.fltk.org/str.php
 //
 
+/**
+  \file fl_draw.H
+  \brief utility header to pull drawing functions together
+*/
+
 #ifndef fl_draw_H
 #define fl_draw_H
 
@@ -37,14 +42,19 @@ class Fl_Image;
 FL_EXPORT extern char fl_draw_shortcut;
 
 // Colors:
-FL_EXPORT void	fl_color(Fl_Color); // select indexed color
+FL_EXPORT void	fl_color(Fl_Color i); // select indexed color
 inline void fl_color(int c) {fl_color((Fl_Color)c);} // for back compatibility
-FL_EXPORT void	fl_color(uchar, uchar, uchar); // select actual color
+FL_EXPORT void	fl_color(uchar r, uchar g, uchar b); // select actual color
 extern FL_EXPORT Fl_Color fl_color_;
+/**
+  Returns the last fl_color() that was set.
+  This can be used for state save/restore.
+*/
 inline Fl_Color fl_color() {return fl_color_;}
 
 // clip:
 FL_EXPORT void fl_push_clip(int x, int y, int w, int h);
+/** The fl_clip() name is deprecated and will be removed from future releases */
 #define fl_clip fl_push_clip
 FL_EXPORT void fl_push_no_clip();
 FL_EXPORT void fl_pop_clip();