Author: AlbrechtS
Date: 2009-09-13 03:04:51 -0700 (Sun, 13 Sep 2009)
New Revision: 6861
Log:
Improved documentation of Fl_Widget::clear_damage(uchar).
Modified:
branches/branch-1.3/FL/Fl_Widget.H
Modified: branches/branch-1.3/FL/Fl_Widget.H
===================================================================
--- branches/branch-1.3/FL/Fl_Widget.H 2009-09-13 09:53:07 UTC (rev 6860)
+++ branches/branch-1.3/FL/Fl_Widget.H 2009-09-13 10:04:51 UTC (rev 6861)
@@ -866,9 +866,16 @@
*/
uchar damage() const {return damage_;}
- /** Clears the damage flags.
+ /** Clears or sets the damage flags.
Damage flags are cleared when parts of the widget drawing is repaired.
- \param[in] c bitmask of flags to clear
+
+ The optional argument \p c specifies the bits that <b>are set</b>
+ after the call (default: 0) and \b not the bits that are cleared!
+
+ \note Therefore it is possible to set damage bits with this method, but
+ this should be avoided. Use damage(uchar) instead.
+
+ \param[in] c new bitmask of damage flags (default: 0)
\see damage(uchar), damage()
*/
void clear_damage(uchar c = 0) {damage_ = c;}
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
