Doxygen documentation: Fixed most important warnings for the Fl_Widget, Fl_Window, Fl_Valuator classes that should be now a 100% documented. For the rest I drastically reduced the undocumented APIs, but many others (less important) remains.

It looks and feels pretty good now :-)


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

1 files changed, 4 insertions, 5 deletions

diff --git a/src/fl_boxtype.cxx b/src/fl_boxtype.cxx
index b0ba175e3..8621962e2 100644
--- a/src/fl_boxtype.cxx
+++ b/src/fl_boxtype.cxx
@@ -322,7 +322,7 @@ void fl_draw_box(Fl_Boxtype t, int x, int y, int w, int h, Fl_Color c) {
 }
 
 //extern Fl_Widget *fl_boxcheat; // hack set by Fl_Window.cxx
-
+/** Draws the widget box according its box style */
 void Fl_Widget::draw_box() const {
   int t = box_;
   if (!t) return;
@@ -333,13 +333,12 @@ void Fl_Widget::draw_box() const {
 //   }
   draw_box((Fl_Boxtype)t, x_, y_, w_, h_, (Fl_Color)color_);
 }
-
+/** Draws a box of type b, of color c at the widget position and size. */
 void Fl_Widget::draw_box(Fl_Boxtype b, Fl_Color c) const {
   draw_box(b, x_, y_, w_, h_, c);
 }
-
-void Fl_Widget::draw_box(Fl_Boxtype b, int X, int Y, int W, int H, Fl_Color c)
-const {
+/** Draws a box of type b, of color c at the widget position X,Y and size W,H. */
+void Fl_Widget::draw_box(Fl_Boxtype b, int X, int Y, int W, int H, Fl_Color c) const {
   draw_it_active = active_r();
   fl_box_table[b].f(X, Y, W, H, c);
   draw_it_active = 1;