From 9017c16ecd2ab6e2b8056054ffc89b4ecec0113a Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Sun, 13 Sep 2009 10:04:51 +0000 Subject: Improved documentation of Fl_Widget::clear_damage(uchar). git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6861 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Widget.H | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/FL/Fl_Widget.H b/FL/Fl_Widget.H index 724e00e00..7c136dc4c 100644 --- a/FL/Fl_Widget.H +++ b/FL/Fl_Widget.H @@ -866,9 +866,16 @@ public: */ 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 are set + 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;} -- cgit v1.2.3