Author: greg.ercolano
Date: 2010-06-03 08:46:59 -0700 (Thu, 03 Jun 2010)
New Revision: 7627
Log:
Document return values for some methods that had none.
Modified:
branches/branch-1.3/src/Fl_Tree_Item.cxx
Modified: branches/branch-1.3/src/Fl_Tree_Item.cxx
===================================================================
--- branches/branch-1.3/src/Fl_Tree_Item.cxx 2010-05-28 07:39:27 UTC (rev
7626)
+++ branches/branch-1.3/src/Fl_Tree_Item.cxx 2010-06-03 15:46:59 UTC (rev
7627)
@@ -261,6 +261,7 @@
/// Descend into the path specified by \p arr, and add a new child there.
/// Should be used only by Fl_Tree's internals.
/// Adds the item based on the value of prefs.sortorder().
+/// \returns the item added.
///
Fl_Tree_Item *Fl_Tree_Item::add(const Fl_Tree_Prefs &prefs, char **arr) {
int t = find_child(*arr);
@@ -278,6 +279,8 @@
}
/// Insert a new item into current item's children at a specified position.
+/// \returns the new item inserted.
+///
Fl_Tree_Item *Fl_Tree_Item::insert(const Fl_Tree_Prefs &prefs, const char
*new_label, int pos) {
Fl_Tree_Item *item = new Fl_Tree_Item(prefs);
item->label(new_label);
@@ -287,6 +290,8 @@
}
/// Insert a new item above this item.
+/// \returns the new item inserted, or 0 if an error occurred.
+///
Fl_Tree_Item *Fl_Tree_Item::insert_above(const Fl_Tree_Prefs &prefs, const
char *new_label) {
Fl_Tree_Item *p = _parent;
if ( ! p ) return(0);
@@ -301,7 +306,7 @@
}
/// Remove child by item.
-/// Returns 0 if removed, -1 if item not an immediate child.
+/// \returns 0 if removed, -1 if item not an immediate child.
///
int Fl_Tree_Item::remove_child(Fl_Tree_Item *item) {
for ( int t=0; t<children(); t++ ) {
@@ -315,7 +320,7 @@
}
/// Remove immediate child (and its children) by its label 'name'.
-/// Returns 0 if removed, -1 if not found.
+/// \returns 0 if removed, -1 if not found.
///
int Fl_Tree_Item::remove_child(const char *name) {
for ( int t=0; t<children(); t++ ) {
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
