Fixed the Doxygen comments of the Fl_Overlay_Window class.

The description of Fl_Overlay_Window ::draw_overlay() didn't appear in Doxygen,
and Fl_Overlay_Window::can_do_overlay() wasn't commented.

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

1 files changed, 22 insertions, 9 deletions

diff --git a/FL/Fl_Overlay_Window.H b/FL/Fl_Overlay_Window.H
index 08ef69294..eb8689c48 100644
--- a/FL/Fl_Overlay_Window.H
+++ b/FL/Fl_Overlay_Window.H
@@ -36,8 +36,18 @@
   overlay will blink if you change the image in the window.
 */
 class FL_EXPORT Fl_Overlay_Window : public Fl_Double_Window {
+#ifndef FL_DOXYGEN
   friend class _Fl_Overlay;
+#endif
+protected:
+  /**
+   You must subclass Fl_Overlay_Window and provide this method.
+   It is just like a draw() method, except it draws the overlay.
+   The overlay will have already been "cleared" when this is called.  You
+   can use any of the routines described in <FL/fl_draw.H>.
+   */
   virtual void draw_overlay() = 0;
+private:
   Fl_Window *overlay_;
 public:
   void show();
@@ -45,21 +55,24 @@ public:
   void hide();
   void resize(int,int,int,int);
   ~Fl_Overlay_Window();
+  /** Returns non-zero if there's hardware overlay support */
   int can_do_overlay();
   void redraw_overlay();
+protected:
   /**
-    Creates a new Fl_Overlay_Window widget using the given
-    position, size, and label (title) string. If the 
-    positions (x,y) are not given, then the window manager
-    will choose them.
-  */
+   See Fl_Overlay_Window::Fl_Overlay_Window(int X, int Y, int W, int H, const char *l=0)
+   */
   Fl_Overlay_Window(int W, int H, const char *l=0)
     : Fl_Double_Window(W,H,l) {overlay_ = 0; force_doublebuffering_=1; image(0); }
-   /**
-    See Fl_Overlay_Window::Fl_Overlay_Window(int W, int H, const char *l=0)
-  */
- Fl_Overlay_Window(int X, int Y, int W, int H, const char *l=0)
+  /**
+   Creates a new Fl_Overlay_Window widget using the given
+   position, size, and label (title) string. If the 
+   positions (x,y) are not given, then the window manager
+   will choose them.
+   */
+  Fl_Overlay_Window(int X, int Y, int W, int H, const char *l=0)
     : Fl_Double_Window(X,Y,W,H,l) {overlay_ = 0; force_doublebuffering_=1; image(0); }
+public:
   void show(int a, char **b) {Fl_Double_Window::show(a,b);}
 };