From e6652d845a06147064fca7f90c76320036a4ee4e Mon Sep 17 00:00:00 2001
From: Fabien Costantini <fabien@onepost.net>
Date: Mon, 15 Sep 2008 20:56:17 +0000
Subject: Doxygen documentation increment 2: adding more classes, comments not
 referenced in original doc. hide public enter_(), exit_() functions, made
 friend Fl_Widget::tooltip(), these should not appear in the public member
 dox. documentation. added static variables initialisation to 0 in glut for
 msvc platform compilers."

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6261 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 FL/Fl_Tooltip.H | 17 ++++++++++-------
 FL/glut.H       |  7 ++++---
 2 files changed, 14 insertions(+), 10 deletions(-)

(limited to 'FL')

diff --git a/FL/Fl_Tooltip.H b/FL/Fl_Tooltip.H
index 13c985efc..15cecf050 100644
--- a/FL/Fl_Tooltip.H
+++ b/FL/Fl_Tooltip.H
@@ -33,21 +33,21 @@
 
 /**
   The Fl_Tooltip class provides tooltip support for
-  all FLTK widgets.
+  all FLTK widgets. It contains only static methods.
 */
 class FL_EXPORT Fl_Tooltip {
 public:
   /**    Gets the tooltip delay. The default delay is 1.0 seconds.  */
-    static float delay() { return delay_; }
+  static float delay() { return delay_; }
   /**    Sets the tooltip delay. The default delay is 1.0 seconds.  */
   static void delay(float f) { delay_ = f; }
   /**
-    Gets or sets the tooltip hover delay, the delay between tooltips.
+    Gets the tooltip hover delay, the delay between tooltips.
     The default delay is 0.2 seconds.
   */
   static float hoverdelay() { return hoverdelay_; }
   /**
-    Gets or sets the tooltip hover delay, the delay between tooltips.
+    Sets the tooltip hover delay, the delay between tooltips.
     The default delay is 0.2 seconds.
   */
   static void hoverdelay(float f) { hoverdelay_ = f; }
@@ -82,18 +82,21 @@ public:
   static void textcolor(unsigned c) { textcolor_ = c; }
 
   // These should not be public, but Fl_Widget::tooltip() needs them...
+  // fabien: made it private with only a friend function access
+private:
+  friend void Fl_Widget::tooltip(const char *);
   static void enter_(Fl_Widget* w);
   static void exit_(Fl_Widget *w);
 
 private:
-  static float delay_;
-  static float hoverdelay_;
+  static float delay_; //!< delay before a tooltip is shown
+  static float hoverdelay_; //!< delay between tooltips
   static int enabled_;
   static unsigned color_;
   static unsigned textcolor_;
   static Fl_Font font_;
   static Fl_Fontsize size_;
-  static Fl_Widget* widget_;
+  static Fl_Widget* widget_; //!< Keeps track of the current target widget
 };
 
 #endif
diff --git a/FL/glut.H b/FL/glut.H
index 585f8224c..1cc242c26 100644
--- a/FL/glut.H
+++ b/FL/glut.H
@@ -42,13 +42,14 @@
 
 #  include "gl.h"
 
-////////////////////////////////////////////////////////////////
-// GLUT is emulated using this window class and these static variables
-// (plus several more static variables hidden in glut_compatability.cxx):
 
 #  include "Fl.H"
 #  include "Fl_Gl_Window.H"
 
+/** 
+  GLUT is emulated using this window class and these static variables
+  (plus several more static variables hidden in glut_compatability.cxx):
+*/
 class FL_EXPORT Fl_Glut_Window : public Fl_Gl_Window {
   void _init();
   int mouse_down;
-- 
cgit v1.2.3