From f9dc24a096d98abf3d3176eee74a759f886c4134 Mon Sep 17 00:00:00 2001
From: engelsman <engelsman>
Date: Sun, 21 Sep 2008 18:55:58 +0000
Subject: 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
---
 FL/Fl_Double_Window.H    |  6 +++++-
 src/Fl_Double_Window.cxx | 15 +++++++++++----
 2 files changed, 16 insertions(+), 5 deletions(-)

diff --git a/FL/Fl_Double_Window.H b/FL/Fl_Double_Window.H
index ad858a933..2c8c5ccd4 100644
--- a/FL/Fl_Double_Window.H
+++ b/FL/Fl_Double_Window.H
@@ -49,7 +49,11 @@
 class FL_EXPORT Fl_Double_Window : public Fl_Window {
 protected:
   void flush(int eraseoverlay);
-  char force_doublebuffering_; // force db, even if the OS already buffers windows (overlays need that on MacOS and Windows2000)
+  /**
+    Force double buffering, even if the OS already buffers windows
+    (overlays need that on MacOS and Windows2000)
+  */
+  char force_doublebuffering_;
 public:
   void show();
   void show(int a, char **b) {Fl_Window::show(a,b);}
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);
-- 
cgit v1.2.3