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
This commit is contained in:
parent
eed2315487
commit
a2eaf60572
@ -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
|
||||
|
@ -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) {}
|
||||
|
@ -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
|
||||
|
@ -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>
|
||||
|
||||
|
@ -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$".
|
||||
//
|
||||
|
@ -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()
|
||||
|
@ -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>
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user