diff options
| author | Fabien Costantini <fabien@onepost.net> | 2008-09-17 20:30:37 +0000 |
|---|---|---|
| committer | Fabien Costantini <fabien@onepost.net> | 2008-09-17 20:30:37 +0000 |
| commit | a2eaf60572320f112e3e9bebb57dbe14450258f0 (patch) | |
| tree | 252c5b2c7125111e11fa181fd26c4059ef273a2c /src/Fl_Gl_Window.cxx | |
| parent | eed231548774950c204e3ba2243c1b26d865fe31 (diff) | |
Doxygen documentation:
+ Added HAVE_GL,HAVE_GL_OVERLAY to Doxyfile defines
+ many obsolete api signature causing to be igmored by doxygen have been fixed, more to come and this is good! (we are forced to refresh these api and be up-to-date to have them documented...)
+ Added a Fl_Gl_Window::draw() method that raises a Fl::fatal() message if used directly. The old doc said it was a pure virtual which is not true. one can easily create a Fl_Gl_Window created, this won't work of course but is subject to trouble.
Now the Fl_Gl_Window doxygenize beautifully and content is more accurate.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6286 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/Fl_Gl_Window.cxx')
| -rw-r--r-- | src/Fl_Gl_Window.cxx | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/src/Fl_Gl_Window.cxx b/src/Fl_Gl_Window.cxx index 47a79cb2d..65c4a0e8d 100644 --- a/src/Fl_Gl_Window.cxx +++ b/src/Fl_Gl_Window.cxx @@ -25,20 +25,6 @@ // http://www.fltk.org/str.php // -/** \fn virtual void Fl_Gl_Window::draw(void) - Fl_Gl_Window::draw() is a pure virtual method. You must - subclass Fl_Gl_Window and provide an implementation for - draw(). You may also provide an implementation of draw_overlay() - if you want to draw into the overlay planes. You can avoid - reinitializing the viewport and lights and other things by checking - valid() at the start of draw() and only doing the - initialization if it is false. - <P>The draw() method can <I>only</I> use OpenGL calls. Do not - attempt to call X, any of the functions in <FL/fl_draw.H>, or glX - directly. Do not call gl_start() or gl_finish(). </P> - <P>If double-buffering is enabled in the window, the back and front - buffers are swapped after this function is completed. -*/ #include "flstring.h" #if HAVE_GL @@ -510,6 +496,22 @@ void Fl_Gl_Window::draw_overlay() {} #endif + /** + You <b>must</b> subclass Fl_Gl_Window and provide an implementation for + draw(). You may also provide an implementation of draw_overlay() + if you want to draw into the overlay planes. You can avoid + reinitializing the viewport and lights and other things by checking + valid() at the start of draw() and only doing the + initialization if it is false. + <P>The draw() method can <I>only</I> use OpenGL calls. Do not + attempt to call X, any of the functions in <FL/fl_draw.H>, or glX + directly. Do not call gl_start() or gl_finish(). </P> + <P>If double-buffering is enabled in the window, the back and front + buffers are swapped after this function is completed. +*/ +void Fl_Gl_Window::draw() { + Fl::fatal("Fl_Gl_Window::draw() *must* be overriden. Please refer to the documentation."); +} // // End of "$Id$". // |