From fdcfef214e67b0b1162ef4098ba960efd7049523 Mon Sep 17 00:00:00 2001
From: Fabien Costantini <fabien@onepost.net>
Date: Mon, 15 Sep 2008 00:27:28 +0000
Subject: Doxygen documentation WP7 Done. Fl_Menu_Item was a real pain to
 doxyfy.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6248 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 FL/Fl_Timer.H | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'FL/Fl_Timer.H')

diff --git a/FL/Fl_Timer.H b/FL/Fl_Timer.H
index 6c9e28067..4f3dada40 100644
--- a/FL/Fl_Timer.H
+++ b/FL/Fl_Timer.H
@@ -37,6 +37,13 @@
 #define FL_VALUE_TIMER		1
 #define FL_HIDDEN_TIMER		2
 
+/**
+  This is provided only to emulate the Forms Timer widget.  It works by
+  making a timeout callback every 1/5 second.  This is wasteful and
+  inaccurate if you just want something to happen a fixed time in the
+  future.  You should directly call 
+  Fl::add_timeout() instead.
+*/
 class FL_EXPORT Fl_Timer : public Fl_Widget {
   static void stepcb(void *);
   void step();
@@ -50,9 +57,21 @@ public:
   Fl_Timer(uchar t,int x,int y,int w,int h, const char *l);
   ~Fl_Timer();
   void value(double);
+  /** See void Fl_Timer::value(double)  */
   double value() const {return delay>0.0?delay:0.0;}
+  /**
+    Gets or sets the direction of the timer.  If the direction is zero
+    then the timer will count up, otherwise it will count down from the
+    initial value().
+  */
   char direction() const {return direction_;}
+  /**
+    Gets or sets the direction of the timer.  If the direction is zero
+    then the timer will count up, otherwise it will count down from the
+    initial value().
+  */
   void direction(char d) {direction_ = d;}
+  /**    Gets or sets whether the timer is suspended.  */
   char suspended() const {return !on;}
   void suspended(char d);
 };
-- 
cgit v1.2.3