Documenting the public methods Fl_Tabs::push()

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

1 files changed, 9 insertions, 1 deletions

diff --git a/src/Fl_Tabs.cxx b/src/Fl_Tabs.cxx
index 430d9cf4b..67d41c40a 100644
--- a/src/Fl_Tabs.cxx
+++ b/src/Fl_Tabs.cxx
@@ -263,7 +263,15 @@ int Fl_Tabs::handle(int event) {
 }
 
 /**
-  \todo This public method needs to be documented
+  This is called by the tab widget's handle() method to set the
+  tab group widget the user last FL_PUSH'ed on. Set back to zero
+  on FL_RELEASE.
+
+  As of this writing, the value is mainly used by draw_tab()
+  to determine whether or not to draw a 'down' box for the tab
+  when it's clicked, and to turn it off if the user drags off it.
+
+  \see push().
 */
 int Fl_Tabs::push(Fl_Widget *o) {
   if (push_ == o) return 0;