Doxygen documentation WP10 Done. Reserved WP11.

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

1 files changed, 23 insertions, 0 deletions

diff --git a/FL/Fl_Adjuster.H b/FL/Fl_Adjuster.H
index 8328e1bda..48a7cc1f4 100644
--- a/FL/Fl_Adjuster.H
+++ b/FL/Fl_Adjuster.H
@@ -34,6 +34,17 @@
 #include "Fl_Valuator.H"
 #endif
 
+/**
+  The Fl_Adjuster widget was stolen from Prisms, and has proven
+  to be very useful for values that need a large dynamic range.
+  <P ALIGN=CENTER>\image html adjuster1.gif</P>
+  <P>When you  press a button and drag to the right the value increases.
+  When you drag  to the left it decreases.  The largest button adjusts by
+  100 *  step(), the next by 10 * step() and that
+  smallest button  by step().  Clicking on the buttons
+  increments by 10 times the  amount dragging by a pixel does. Shift +
+  click decrements by 10 times  the amount.
+*/
 class FL_EXPORT Fl_Adjuster : public Fl_Valuator {
   int drag;
   int ix;
@@ -44,7 +55,19 @@ protected:
   void value_damage();
 public:
   Fl_Adjuster(int X,int Y,int W,int H,const char *l=0);
+  /**
+    If &quot;soft&quot; is turned on, the user is allowed to drag the value outside
+    the range.  If they drag the value to one of the ends, let go, then
+    grab again and continue to drag, they can get to any value.  Default is
+    one.
+  */
   void soft(int s) {soft_ = s;}
+  /**
+    If &quot;soft&quot; is turned on, the user is allowed to drag the value outside
+    the range.  If they drag the value to one of the ends, let go, then
+    grab again and continue to drag, they can get to any value.  Default is
+    one.
+  */
   int soft() const {return soft_;}
 };