From b9ca1333769f87c029430a9d14a7a9937d400f93 Mon Sep 17 00:00:00 2001
From: Fabien Costantini <fabien@onepost.net>
Date: Mon, 15 Sep 2008 08:41:54 +0000
Subject:  Doxygen documentation WP8 Done. Reserved WP9, WP10. Will now check
 WP3 from engelsman and integrates it.

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

(limited to 'FL/Fl_Round_Button.H')

diff --git a/FL/Fl_Round_Button.H b/FL/Fl_Round_Button.H
index f1bf6ed0b..c0365add1 100644
--- a/FL/Fl_Round_Button.H
+++ b/FL/Fl_Round_Button.H
@@ -30,6 +30,17 @@
 
 #include "Fl_Light_Button.H"
 
+/**
+  Buttons generate callbacks when they are clicked by the user.  You
+  control exactly when and how by changing the values for type()
+  and when().
+  <P ALIGN=CENTER>\image html Fl_Round_Button.gif</P>
+  <P>The Fl_Round_Button subclass display the &quot;on&quot; state by
+  turning on a light, rather than drawing pushed in.  The shape of the
+  &quot;light&quot; is initially set to FL_ROUND_DOWN_BOX.  The color of the light
+  when on is controlled with selection_color(), which defaults to
+  FL_RED.
+*/
 class FL_EXPORT Fl_Round_Button : public Fl_Light_Button {
 public:
   Fl_Round_Button(int x,int y,int w,int h,const char *l = 0);
-- 
cgit v1.2.3