From 2aefc1f60ce1d9aad59f1daecc1ddd5caa9f3924 Mon Sep 17 00:00:00 2001
From: Greg Ercolano <erco@seriss.com>
Date: Tue, 26 Mar 2013 01:55:01 +0000
Subject: Added docs for undocumented public 'which()' method. Added a \todo
 marker for undocumented public 'push()' method.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9849 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 FL/Fl_Tabs.H    |  3 +++
 src/Fl_Tabs.cxx | 12 ++++++++++--
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/FL/Fl_Tabs.H b/FL/Fl_Tabs.H
index 845069dd0..009e07be3 100644
--- a/FL/Fl_Tabs.H
+++ b/FL/Fl_Tabs.H
@@ -68,6 +68,9 @@ public:
   int handle(int);
   Fl_Widget *value();
   int value(Fl_Widget *);
+  /**
+  \todo This public method needs to be documented
+  */
   Fl_Widget *push() const {return push_;}
   int push(Fl_Widget *);
   Fl_Tabs(int,int,int,int,const char * = 0);
diff --git a/src/Fl_Tabs.cxx b/src/Fl_Tabs.cxx
index 8fc827421..430d9cf4b 100644
--- a/src/Fl_Tabs.cxx
+++ b/src/Fl_Tabs.cxx
@@ -114,8 +114,13 @@ int Fl_Tabs::tab_height() {
   else return (H <= 0) ? 0 : H;
 }
 
-// This is used for event handling (clicks) and by fluid to pick tabs.
-// Returns 0, if children() = 0, or if the event is outside of the tabs area.
+/**
+  Return the widget of the tab the user clicked on at \p event_x / \p event_y.
+  This is used for event handling (clicks) and by fluid to pick tabs.
+
+  \returns The child widget of the tab the user clicked on, or<br>
+           0 if there are no children or if the event is outside of the tabs area.
+*/
 Fl_Widget *Fl_Tabs::which(int event_x, int event_y) {
   if (children() == 0) return 0;
   int H = tab_height();
@@ -257,6 +262,9 @@ int Fl_Tabs::handle(int event) {
   }
 }
 
+/**
+  \todo This public method needs to be documented
+*/
 int Fl_Tabs::push(Fl_Widget *o) {
   if (push_ == o) return 0;
   if ( (push_ && !push_->visible()) || (o && !o->visible()) )
-- 
cgit v1.2.3