diff options
| -rw-r--r-- | FL/Fl_Gl_Window.H | 3 | ||||
| -rw-r--r-- | FL/Fl_Repeat_Button.H | 4 | ||||
| -rw-r--r-- | documentation/Doxyfile | 2 | ||||
| -rw-r--r-- | src/Fl_Box.cxx | 3 | ||||
| -rw-r--r-- | src/Fl_Gl_Window.cxx | 30 | ||||
| -rw-r--r-- | src/Fl_Help_Dialog_Dox.cxx | 2 | ||||
| -rw-r--r-- | src/Fl_Repeat_Button.cxx | 3 |
7 files changed, 24 insertions, 23 deletions
diff --git a/FL/Fl_Gl_Window.H b/FL/Fl_Gl_Window.H index 3bf95dd0f..d70094f9f 100644 --- a/FL/Fl_Gl_Window.H +++ b/FL/Fl_Gl_Window.H @@ -202,6 +202,9 @@ public: Fl_Gl_Window(int W, int H, const char *l=0) : Fl_Window(W,H,l) {init();} Fl_Gl_Window(int X, int Y, int W, int H, const char *l=0) : Fl_Window(X,Y,W,H,l) {init();} + + // you *must* override the draw method + virtual void draw(); }; #endif diff --git a/FL/Fl_Repeat_Button.H b/FL/Fl_Repeat_Button.H index 73fb83773..b82718df1 100644 --- a/FL/Fl_Repeat_Button.H +++ b/FL/Fl_Repeat_Button.H @@ -45,8 +45,8 @@ public: int handle(int); /** Creates a new Fl_Repeat_Button widget using the given - position, size, and label string. The default boxtype is FL_UP_BOX - . + position, size, and label string. The default boxtype is FL_UP_BOX. + Deletes the button. */ Fl_Repeat_Button(int X,int Y,int W,int H,const char *l=0) : Fl_Button(X,Y,W,H,l) {} diff --git a/documentation/Doxyfile b/documentation/Doxyfile index 875f08bb0..06fa1d9dc 100644 --- a/documentation/Doxyfile +++ b/documentation/Doxyfile @@ -1127,6 +1127,8 @@ INCLUDE_FILE_PATTERNS = # instead of the = operator. PREDEFINED = FL_DOXYGEN \ + HAVE_GL \ + HAVE_GL_OVERLAY \ FL_EXPORT:= # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 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 <FL/Fl_Widget.H> #include <FL/Fl_Box.H> 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$". // 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 <FL/Fl.H> #include <FL/Fl_Repeat_Button.H> |