Update docs related to buttons and update Fl_Check_Button.png.

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

6 files changed, 24 insertions, 34 deletions

diff --git a/FL/Fl_Button.H b/FL/Fl_Button.H
index 9cfcc7d5d..33c684962 100644
--- a/FL/Fl_Button.H
+++ b/FL/Fl_Button.H
@@ -3,10 +3,10 @@
 //
 // Button header file for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2010 by Bill Spitzak and others.
+// Copyright 1998-2014 by Bill Spitzak and others.
 //
 // This library is free software. Distribution and use rights are outlined in
-// the file "COPYING" which should have been included with this file.  If this
+// the file "COPYING" which should have been included with this file. If this
 // file is missing or damaged, see the license at:
 //
 //     http://www.fltk.org/COPYING.php
@@ -27,7 +27,7 @@
 #endif
 
 // values for type()
-#define FL_NORMAL_BUTTON	0   /**< value() will be set to 1 during the press of the button and 
+#define FL_NORMAL_BUTTON	0   /**< value() will be set to 1 during the press of the button and
                                          reverts back to 0 when the button is released */
 #define FL_TOGGLE_BUTTON	1   ///< value() toggles between 0 and 1 at every click of the button
 #define FL_RADIO_BUTTON		(FL_RESERVED_TYPE+2) /**< is set to 1 at button press, and all other
@@ -42,7 +42,7 @@ class Fl_Widget_Tracker;
 /**
   \class Fl_Button
   \brief Buttons generate callbacks when they are clicked by the user.
-  
+
   You control exactly when and how by changing the values for type() and
   when().  Buttons can also generate callbacks in response to \c FL_SHORTCUT
   events.  The button can either have an explicit shortcut(int s) value or a
@@ -72,6 +72,7 @@ class Fl_Widget_Tracker;
          (when the user pushes and releases the button, and as the mouse is
 	 dragged around in and out of the button).
 */
+
 class FL_EXPORT Fl_Button : public Fl_Widget {
 
   int shortcut_;
@@ -84,7 +85,7 @@ protected:
   static Fl_Widget_Tracker *key_release_tracker;
   static void key_release_timeout(void*);
   void simulate_key_action();
-  
+
   virtual void draw();
 
 public:
@@ -150,6 +151,10 @@ public:
   /**
     Sets the down box type. The default value of 0 causes FLTK to figure out
     the correct matching down version of box().
+
+    Some derived classes (e.g. Fl_Round_Button and Fl_Light_Button use
+    down_box() for special purposes. See docs of these classes.
+
     \param[in] b down box type
    */
   void down_box(Fl_Boxtype b) {down_box_ = b;}
diff --git a/FL/Fl_Check_Button.H b/FL/Fl_Check_Button.H
index c439ab757..9c67c73bb 100644
--- a/FL/Fl_Check_Button.H
+++ b/FL/Fl_Check_Button.H
@@ -3,10 +3,10 @@
 //
 // Check button header file for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2010 by Bill Spitzak and others.
+// Copyright 1998-2014 by Bill Spitzak and others.
 //
 // This library is free software. Distribution and use rights are outlined in
-// the file "COPYING" which should have been included with this file.  If this
+// the file "COPYING" which should have been included with this file. If this
 // file is missing or damaged, see the license at:
 //
 //     http://www.fltk.org/COPYING.php
@@ -16,29 +16,17 @@
 //     http://www.fltk.org/str.php
 //
 
-/* \file
-   Fl_Check_Button widget . */
-
 #ifndef Fl_Check_Button_H
 #define Fl_Check_Button_H
 
 #include "Fl_Light_Button.H"
 
-/**
-  \class Fl_Check_Button
-  \brief A button with an "checkmark" to show its status.
+/*
+  class: Fl_Check_Button.
 
-  \image html Fl_Check_Button.png
-  \image latex Fl_Check_Button.png  "Fl_Check_Button" width=4cm
-  Buttons generate callbacks when they are clicked by the user. You control
-  exactly when and how by changing the values for type() and when().
+  A button with a "checkmark" to show its status.
+*/
 
-  The Fl_Check_Button subclass displays its "ON" state by showing a "checkmark"
-  rather than drawing itself pushed in.
-  
-  \todo Refactor Fl_Check_Button doxygen comments (add color() info etc?)
-  \todo Generate Fl_Check_Button.gif with visible checkmark.
- */
 class FL_EXPORT Fl_Check_Button : public Fl_Light_Button {
 public:
   Fl_Check_Button(int X, int Y, int W, int H, const char *L = 0);
diff --git a/FL/Fl_Radio_Button.H b/FL/Fl_Radio_Button.H
index 99d0922ca..5dafe42a8 100644
--- a/FL/Fl_Radio_Button.H
+++ b/FL/Fl_Radio_Button.H
@@ -3,10 +3,10 @@
 //
 // Radio button header file for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2010 by Bill Spitzak and others.
+// Copyright 1998-2014 by Bill Spitzak and others.
 //
 // This library is free software. Distribution and use rights are outlined in
-// the file "COPYING" which should have been included with this file.  If this
+// the file "COPYING" which should have been included with this file. If this
 // file is missing or damaged, see the license at:
 //
 //     http://www.fltk.org/COPYING.php
diff --git a/FL/Fl_Radio_Light_Button.H b/FL/Fl_Radio_Light_Button.H
index 352dccfda..5945be11f 100644
--- a/FL/Fl_Radio_Light_Button.H
+++ b/FL/Fl_Radio_Light_Button.H
@@ -3,10 +3,10 @@
 //
 // Radio light button header file for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2010 by Bill Spitzak and others.
+// Copyright 1998-2014 by Bill Spitzak and others.
 //
 // This library is free software. Distribution and use rights are outlined in
-// the file "COPYING" which should have been included with this file.  If this
+// the file "COPYING" which should have been included with this file. If this
 // file is missing or damaged, see the license at:
 //
 //     http://www.fltk.org/COPYING.php
diff --git a/FL/Fl_Radio_Round_Button.H b/FL/Fl_Radio_Round_Button.H
index a53673827..91f53481a 100644
--- a/FL/Fl_Radio_Round_Button.H
+++ b/FL/Fl_Radio_Round_Button.H
@@ -3,10 +3,10 @@
 //
 // Radio round button header file for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2010 by Bill Spitzak and others.
+// Copyright 1998-2014 by Bill Spitzak and others.
 //
 // This library is free software. Distribution and use rights are outlined in
-// the file "COPYING" which should have been included with this file.  If this
+// the file "COPYING" which should have been included with this file. If this
 // file is missing or damaged, see the license at:
 //
 //     http://www.fltk.org/COPYING.php
diff --git a/FL/Fl_Round_Button.H b/FL/Fl_Round_Button.H
index d71e75766..f5cb03325 100644
--- a/FL/Fl_Round_Button.H
+++ b/FL/Fl_Round_Button.H
@@ -3,10 +3,10 @@
 //
 // Round button header file for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2010 by Bill Spitzak and others.
+// Copyright 1998-2014 by Bill Spitzak and others.
 //
 // This library is free software. Distribution and use rights are outlined in
-// the file "COPYING" which should have been included with this file.  If this
+// the file "COPYING" which should have been included with this file. If this
 // file is missing or damaged, see the license at:
 //
 //     http://www.fltk.org/COPYING.php
@@ -16,9 +16,6 @@
 //     http://www.fltk.org/str.php
 //
 
-/* \file
-   Fl_Round_Button widget . */
-
 #ifndef Fl_Round_Button_H
 #define Fl_Round_Button_H