doxygen comments for undocumented features of Fl_Double_Window

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6338 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

1 files changed, 11 insertions, 4 deletions

diff --git a/src/Fl_Double_Window.cxx b/src/Fl_Double_Window.cxx
index def6f818e..6c86284e7 100644
--- a/src/Fl_Double_Window.cxx
+++ b/src/Fl_Double_Window.cxx
@@ -327,12 +327,19 @@ char fl_can_do_alpha_blending() {
 
 #endif
 
-// Fl_Overlay_Window relies on flush(1) copying the back buffer to the
-// front everywhere, even if damage() == 0, thus erasing the overlay,
-// and leaving the clip region set to the entire window.
-
+/**
+  Forces the window to be redrawn.
+*/
 void Fl_Double_Window::flush() {flush(0);}
 
+/**
+  Forces the window to be redrawn.
+  \param[in] eraseoverlay non-zero to erase overlay, zero to ignore
+
+  Fl_Overlay_Window relies on flush(1) copying the back buffer to the
+  front everywhere, even if damage() == 0, thus erasing the overlay,
+  and leaving the clip region set to the entire window.
+*/
 void Fl_Double_Window::flush(int eraseoverlay) {
   make_current(); // make sure fl_gc is non-zero
   Fl_X *myi = Fl_X::i(this);