Author: greg.ercolano
Date: 2013-03-25 18:55:01 -0700 (Mon, 25 Mar 2013)
New Revision: 9849
Log:
Added docs for undocumented public 'which()' method.
Added a \todo marker for undocumented public 'push()' method.
Modified:
branches/branch-1.3/FL/Fl_Tabs.H
branches/branch-1.3/src/Fl_Tabs.cxx
Modified: branches/branch-1.3/FL/Fl_Tabs.H
===================================================================
--- branches/branch-1.3/FL/Fl_Tabs.H 2013-03-25 23:20:29 UTC (rev 9848)
+++ branches/branch-1.3/FL/Fl_Tabs.H 2013-03-26 01:55:01 UTC (rev 9849)
@@ -68,6 +68,9 @@
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);
Modified: branches/branch-1.3/src/Fl_Tabs.cxx
===================================================================
--- branches/branch-1.3/src/Fl_Tabs.cxx 2013-03-25 23:20:29 UTC (rev 9848)
+++ branches/branch-1.3/src/Fl_Tabs.cxx 2013-03-26 01:55:01 UTC (rev 9849)
@@ -114,8 +114,13 @@
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 @@
}
}
+/**
+ \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()) )
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
