Doxygen Documentation WP4 Done. Has all documentation content but should be completed in increment 2. Registered for WP5.

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

1 files changed, 26 insertions, 0 deletions

diff --git a/FL/Fl_Dial.H b/FL/Fl_Dial.H
index 2449f43dd..076c833dd 100644
--- a/FL/Fl_Dial.H
+++ b/FL/Fl_Dial.H
@@ -37,6 +37,18 @@
 #define FL_LINE_DIAL	1
 #define FL_FILL_DIAL	2
 
+/**
+  The Fl_Dial widget provides a circular dial to control a
+  single floating point value.
+  <P ALIGN=CENTER>\image html dial.gif
+  Use type() to set the type of the dial to:
+  <UL>
+  <LI>FL_NORMAL_DIAL - Draws a normal dial with a knob. </LI>
+  <LI>FL_LINE_DIAL - Draws a dial with a line. </LI>
+  <LI>FL_FILL_DIAL - Draws a dial with a filled arc. </LI>
+  </UL>
+
+*/
 class FL_EXPORT Fl_Dial : public Fl_Valuator {
 
   short a1,a2;
@@ -51,11 +63,25 @@ protected:
 public:
 
   int handle(int);
+  /**
+    Creates a new Fl_Dial widget using the given position, size,
+    and label string. The default type is FL_NORMAL_DIAL.
+  */
   Fl_Dial(int x,int y,int w,int h, const char *l = 0);
+  /** 
+     Sets Or gets the angles used for the minimum and maximum values.  The default
+     values are 45 and 315 (0 degrees is straight down and the angles
+     progress clockwise).  Normally angle1 is less than angle2, but if you
+     reverse them the dial moves counter-clockwise.
+  */
   short angle1() const {return a1;}
+  /** See short angle1() const */
   void angle1(short a) {a1 = a;}
+  /** See short angle1() const */
   short angle2() const {return a2;}
+  /** See short angle1() const */
   void angle2(short a) {a2 = a;}
+  /** See short angle1() const */
   void angles(short a, short b) {a1 = a; a2 = b;}
 
 };