From a2eaf60572320f112e3e9bebb57dbe14450258f0 Mon Sep 17 00:00:00 2001 From: Fabien Costantini Date: Wed, 17 Sep 2008 20:30:37 +0000 Subject: 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 --- src/Fl_Box.cxx | 3 --- src/Fl_Gl_Window.cxx | 30 ++++++++++++++++-------------- src/Fl_Help_Dialog_Dox.cxx | 2 +- src/Fl_Repeat_Button.cxx | 3 --- 4 files changed, 17 insertions(+), 21 deletions(-) (limited to 'src') diff --git a/src/Fl_Box.cxx b/src/Fl_Box.cxx index 061368658..4b7baa99e 100644 --- a/src/Fl_Box.cxx +++ b/src/Fl_Box.cxx @@ -25,9 +25,6 @@ // http://www.fltk.org/str.php // -/** \fn Fl_Box::~Fl_Box(void) - The destructor removes the box.*/ - #include #include 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. -

The draw() method can only 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().

-

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 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. +

The draw() method can only 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().

+

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$". // diff --git a/src/Fl_Help_Dialog_Dox.cxx b/src/Fl_Help_Dialog_Dox.cxx index e7f753434..f41f84032 100644 --- a/src/Fl_Help_Dialog_Dox.cxx +++ b/src/Fl_Help_Dialog_Dox.cxx @@ -59,7 +59,7 @@ /** \fn void Fl_Help_Dialog::show() Shows the Fl_Help_Dialog window.*/ -/** \fn void Fl_Help_Dialog::textsize(uchar s) +/** \fn void Fl_Help_Dialog::textsize(Fl_Fontsize s) Sets or gets the default text size for the help view.*/ /** \fn uchar Fl_Help_Dialog::textsize() diff --git a/src/Fl_Repeat_Button.cxx b/src/Fl_Repeat_Button.cxx index 5e958bb82..45d69dce6 100644 --- a/src/Fl_Repeat_Button.cxx +++ b/src/Fl_Repeat_Button.cxx @@ -25,9 +25,6 @@ // http://www.fltk.org/str.php // -/** \fn virtual Fl_Repeat_Button::~Fl_Repeat_Button() - Deletes the button.*/ - #include #include -- cgit v1.2.3