diff options
| author | Fabien Costantini <fabien@onepost.net> | 2008-09-17 22:25:45 +0000 |
|---|---|---|
| committer | Fabien Costantini <fabien@onepost.net> | 2008-09-17 22:25:45 +0000 |
| commit | 2be88792b3746c72d82448f8373bc7d6b322d38a (patch) | |
| tree | 15ef46c26f31448bbcd48d13b9f8788ddeb16e8f /src | |
| parent | 74cbd55745e7c55a62be524279c707a572f6c688 (diff) | |
Doxygen documentation: fixed all ambiguous methods signatures, fixed erroneous path test into ../test since the doxyfile move, fixed all intro dl,dt,dd related tags warnings in intro.dox .
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6289 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src')
| -rw-r--r-- | src/Fl_BMP_Image.cxx | 6 | ||||
| -rw-r--r-- | src/Fl_File_Chooser2.cxx | 3 | ||||
| -rw-r--r-- | src/Fl_Gl_Window.cxx | 1 | ||||
| -rw-r--r-- | src/Fl_Help_Dialog_Dox.cxx | 2 | ||||
| -rw-r--r-- | src/Fl_Preferences.cxx | 4 | ||||
| -rw-r--r-- | src/Fl_Return_Button.cxx | 3 | ||||
| -rw-r--r-- | src/Fl_Scroll.cxx | 2 | ||||
| -rw-r--r-- | src/Fl_Valuator.cxx | 18 | ||||
| -rw-r--r-- | src/Fl_Value_Slider.cxx | 3 |
9 files changed, 19 insertions, 23 deletions
diff --git a/src/Fl_BMP_Image.cxx b/src/Fl_BMP_Image.cxx index 4c5e31da6..ba2587846 100644 --- a/src/Fl_BMP_Image.cxx +++ b/src/Fl_BMP_Image.cxx @@ -59,14 +59,12 @@ static int read_long(FILE *fp); static unsigned short read_word(FILE *fp); static unsigned int read_dword(FILE *fp); -/** \fn Fl_BMP_Image::~Fl_BMP_Image() -*/ - - /** The constructor loads the named BMP image from the given bmp filename. <P>The inherited destructor free all memory and server resources that are used by the image. + <P>The destructor free all memory and server resources that are used by + the image */ Fl_BMP_Image::Fl_BMP_Image(const char *bmp) // I - File to read : Fl_RGB_Image(0,0,0) { diff --git a/src/Fl_File_Chooser2.cxx b/src/Fl_File_Chooser2.cxx index 9cf693a1f..0484b5f3d 100644 --- a/src/Fl_File_Chooser2.cxx +++ b/src/Fl_File_Chooser2.cxx @@ -31,7 +31,7 @@ The Fl_File_Chooser widget displays a standard file selection dialog that supports various selection modes. - <CENTER>\image html Fl_File_Chooser.jpg</CENTER> + <P ALIGN=CENTER>\image html Fl_File_Chooser.jpg</P> <P>The Fl_File_Chooser class also exports several static values that may be used to localize or customize the appearance of all file chooser @@ -100,7 +100,6 @@ <TD>fl_numericsort</TD> </TR> </TABLE></CENTER> - <P>The sort member specifies the sort function that is used when loading the contents of a directory. */ diff --git a/src/Fl_Gl_Window.cxx b/src/Fl_Gl_Window.cxx index 65c4a0e8d..c177819e6 100644 --- a/src/Fl_Gl_Window.cxx +++ b/src/Fl_Gl_Window.cxx @@ -25,7 +25,6 @@ // http://www.fltk.org/str.php // - #include "flstring.h" #if HAVE_GL diff --git a/src/Fl_Help_Dialog_Dox.cxx b/src/Fl_Help_Dialog_Dox.cxx index f41f84032..c9febddac 100644 --- a/src/Fl_Help_Dialog_Dox.cxx +++ b/src/Fl_Help_Dialog_Dox.cxx @@ -31,7 +31,7 @@ The Fl_Help_Dialog widget displays a standard help dialog window using the Fl_Help_View widget. - <CENTER>\image html Fl_Help_Dialog.gif</CENTER> + <P ALIGN=CENTER> \image html Fl_Help_Dialog.gif </P> */ /** \fn Fl_Help_Dialog::Fl_Help_Dialog() diff --git a/src/Fl_Preferences.cxx b/src/Fl_Preferences.cxx index 28b6950a4..a44509a0b 100644 --- a/src/Fl_Preferences.cxx +++ b/src/Fl_Preferences.cxx @@ -142,9 +142,9 @@ int Fl_Preferences::groups() * - the index must be within the range given by groups() * example: printf( "Group(%d)='%s'\n", ix, base.group(ix) ); */ -const char *Fl_Preferences::group( int ix ) +const char *Fl_Preferences::group( int num_group ) { - return node->child( ix ); + return node->child( num_group ); } diff --git a/src/Fl_Return_Button.cxx b/src/Fl_Return_Button.cxx index 7f0a42b13..7a520c948 100644 --- a/src/Fl_Return_Button.cxx +++ b/src/Fl_Return_Button.cxx @@ -25,9 +25,6 @@ // http://www.fltk.org/str.php // -/** \fn virtual Fl_Return_Button::~Fl_Return_Button() - Deletes the button.*/ - #include <FL/Fl.H> #include <FL/Fl_Return_Button.H> #include <FL/fl_draw.H> diff --git a/src/Fl_Scroll.cxx b/src/Fl_Scroll.cxx index 2014d7bd7..29c4c3d33 100644 --- a/src/Fl_Scroll.cxx +++ b/src/Fl_Scroll.cxx @@ -288,7 +288,7 @@ void Fl_Scroll::scrollbar_cb(Fl_Widget* o, void*) { /** Creates a new Fl_Scroll widget using the given position, size, and label string. The default boxtype is FL_NO_BOX. - <B>The destructor <I>also deletes all the children</I>. This allows a + <P>The destructor <I>also deletes all the children</I>. This allows a whole tree to be deleted at once, without having to keep a pointer to all the children in the user code. A kludge has been done so the Fl_Scroll and all of it's children can be automatic (local) diff --git a/src/Fl_Valuator.cxx b/src/Fl_Valuator.cxx index 8e552ba78..7a76220df 100644 --- a/src/Fl_Valuator.cxx +++ b/src/Fl_Valuator.cxx @@ -25,11 +25,6 @@ // http://www.fltk.org/str.php // -/** \fn int Fl_Valuator::changed() const - This value is true if the user has moved the slider. It is - turned off by value(x) and just before doing a callback - (the callback can turn it back on if desired). -*/ // Base class for sliders and all other one-value "knobs" @@ -65,7 +60,7 @@ void Fl_Valuator::step(double s) { while (fabs(s-A/B) > epsilon && B<=(0x7fffffff/10)) {B *= 10; A = rint(s*B);} } -/** Sets the step value to 1/10<SUP>digits.*/ +/** Sets the step value to 1/10<SUP>digits</SUP>.*/ void Fl_Valuator::precision(int p) { A = 1.0; for (B = 1; p--;) B *= 10; @@ -73,7 +68,16 @@ void Fl_Valuator::precision(int p) { /** Asks for partial redraw */ void Fl_Valuator::value_damage() {damage(FL_DAMAGE_EXPOSE);} // by default do partial-redraw -/** See double Fl_Valuator::value() const */ +/** + Sets the current value. The new value is <I>not</I> + clamped or otherwise changed before storing it. Use + clamp() or round() to modify the value before + calling value(). The widget is redrawn if the new value + is different than the current one. The initial value is zero. + <P>changed() will return true if the user has moved the slider, + but it will be turned off by value(x) and just before doing a callback + (the callback can turn it back on if desired). +*/ int Fl_Valuator::value(double v) { clear_changed(); if (v == value_) return 0; diff --git a/src/Fl_Value_Slider.cxx b/src/Fl_Value_Slider.cxx index 6b666645f..9c3a71fe1 100644 --- a/src/Fl_Value_Slider.cxx +++ b/src/Fl_Value_Slider.cxx @@ -32,8 +32,7 @@ /** Creates a new Fl_Value_Slider widget using the given - position, size, and label string. The default boxtype is FL_DOWN_BOX - . + position, size, and label string. The default boxtype is FL_DOWN_BOX. */ Fl_Value_Slider::Fl_Value_Slider(int X, int Y, int W, int H, const char*l) : Fl_Slider(X,Y,W,H,l) { |
