diff --git a/FL/Fl_Browser.H b/FL/Fl_Browser.H index a31149c03..0955d87bf 100644 --- a/FL/Fl_Browser.H +++ b/FL/Fl_Browser.H @@ -158,8 +158,8 @@ public:
\image html text.gif
There is a single subclass, Fl_Multiline_Output, which allows you to display multiple lines of text.
diff --git a/FL/Fl_Preferences.H b/FL/Fl_Preferences.H index 6ed132f95..7ff43e9f5 100644 --- a/FL/Fl_Preferences.H +++ b/FL/Fl_Preferences.H @@ -151,10 +151,10 @@ public: order of group names. The index must be within the range given by groups(). - \param[in] index number indexing the requested group + \param[in] num_group number indexing the requested group \return cstring pointer to the group name */ - const char *group( int index ); + const char *group( int num_group ); /** Returns non-zero if a group with this name exists. @@ -162,10 +162,10 @@ public: "." describes the current node, "./" describes the topmost node. By preceding a groupname with a "./", its path becomes relative to the topmost node. - \param[in] group name of group that is searched for + \param[in] key name of group that is searched for \return 0 if group was not found */ - char groupExists( const char *group ); + char groupExists( const char *key ); /** Deletes a group. @@ -196,10 +196,10 @@ public: /** Returns non-zero if an entry with this name exists. - \param[in] entry name of entry that is searched for + \param[in] key name of entry that is searched for \return 0 if entry was not found */ - char entryExists( const char *entry ); + char entryExists( const char *key ); /** Removes a single entry (name/value pair). diff --git a/FL/Fl_Return_Button.H b/FL/Fl_Return_Button.H index 06947ee58..c7e9813d9 100644 --- a/FL/Fl_Return_Button.H +++ b/FL/Fl_Return_Button.H @@ -45,8 +45,8 @@ public: int handle(int); /** Creates a new Fl_Return_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. +The inherited destructor deletes the button. */ Fl_Return_Button(int X, int Y, int W, int H,const char *l=0) : Fl_Button(X,Y,W,H,l) {} diff --git a/FL/Fl_Spinner.H b/FL/Fl_Spinner.H index 73e549f13..f91eadbf5 100644 --- a/FL/Fl_Spinner.H +++ b/FL/Fl_Spinner.H @@ -176,15 +176,15 @@ class Fl_Spinner : public Fl_Group /** Speling mistakes retained for source compatibility \deprecated */ double maxinum() const { return (maximum_); } - /** Sets or returns the maximum value of the widget. */ + /** Gets the maximum value of the widget. */ double maximum() const { return (maximum_); } - /** Sets or returns the maximum value of the widget. */ + /** Sets the maximum value of the widget. */ void maximum(double m) { maximum_ = m; } /** Speling mistakes retained for source compatibility \deprecated */ double mininum() const { return (minimum_); } - /** Sets or returns the minimum value of the widget. */ + /** Gets the minimum value of the widget. */ double minimum() const { return (minimum_); } - /** Sets or returns the minimum value of the widget. */ + /** Sets the minimum value of the widget. */ void minimum(double m) { minimum_ = m; } /** Sets the minimum and maximum values for the widget. */ void range(double a, double b) { minimum_ = a; maximum_ = b; } @@ -209,31 +209,31 @@ class Fl_Spinner : public Fl_Group else input_.type(FL_INT_INPUT); update(); } - /** Sets or Gets the color of the text in the input field. */ + /** Gets the color of the text in the input field. */ Fl_Color textcolor() const { return (input_.textcolor()); } - /** Sets or Gets the color of the text in the input field. */ + /** Sets the color of the text in the input field. */ void textcolor(Fl_Color c) { input_.textcolor(c); } - /** Sets or Gets the font of the text in the input field. */ + /** Gets the font of the text in the input field. */ Fl_Font textfont() const { return (input_.textfont()); } - /** Sets or Gets the font of the text in the input field. */ + /** Sets the font of the text in the input field. */ void textfont(Fl_Font f) { input_.textfont(f); } - /** Sets or Gets the size of the text in the input field. */ + /** Gets the size of the text in the input field. */ Fl_Fontsize textsize() const { return (input_.textsize()); } - /** Sets or Gets the size of the text in the input field. */ + /** Sets the size of the text in the input field. */ void textsize(Fl_Fontsize s) { input_.textsize(s); } - /** Sets or returns the numeric representation in the input field. + /** Sets or Gets the numeric representation in the input field. Valid values are FL_INT_INPUT and FL_FLOAT_INPUT. The first form also changes the format() template. Setting a new spinner type via a superclass pointer will not work. @@ -249,13 +249,13 @@ class Fl_Spinner : public Fl_Group } input_.type(v); } + /** Gets the current value of the widget. */ + double value() const { return (value_); } /** - Sets or returns the current value of the widget. + Sets the current value of the widget. Before setting value to a non-integer value, the spinner type() should be changed to floating point. */ - double value() const { return (value_); } - /** See double Fl_Spinner::value() const */ void value(double v) { value_ = v; update(); } }; diff --git a/FL/Fl_Valuator.H b/FL/Fl_Valuator.H index a90e60223..eb2d8a814 100644 --- a/FL/Fl_Valuator.H +++ b/FL/Fl_Valuator.H @@ -43,14 +43,13 @@ The Fl_Valuator class controls a single floating-point value and provides a consistent interface to set the value, range, and step, and insures that callbacks are done the same for every object. -
There are probably more of these classes in FLTK than any others:
+There are probably more of these classes in FLTK than any others:
\image html valuators.gif
In the above diagram each box surrounds an actual subclass. These - are further differentiated by setting the - type() of the widget to the symbolic value labeling the - widget. The ones labelled "0" are the default versions with a - type(0). For consistency the symbol FL_VERTICAL is - defined as zero. + are further differentiated by setting the type() of the widget t + o the symbolic value labeling the widget. + The ones labelled "0" are the default versions with a type(0). + For consistency the symbol FL_VERTICAL is defined as zero. */ class FL_EXPORT Fl_Valuator : public Fl_Widget { @@ -124,13 +123,7 @@ public: double step() const {return A/B;} void precision(int); - /** - Gets or sets the current value. The new value is not - 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. - */ + /** Gets the floating point(double) value. See int value(double) */ double value() const {return value_;} int value(double); diff --git a/FL/Fl_Widget.H b/FL/Fl_Widget.H index 67741b228..fbdd61524 100644 --- a/FL/Fl_Widget.H +++ b/FL/Fl_Widget.H @@ -249,9 +249,9 @@ public: int damage_resize(int,int,int,int); /** Reposition the window or widget. - * position(x,y) is a shortcut for resize(x,y,w(),h()). + * position(X,Y) is a shortcut for resize(X,Y,w(),h()). * - * \param[in] x, y new position relative to the parent window + * \param[in] X, Y new position relative to the parent window * \see resize(int, int, int, int), size(int, int) */ void position(int X,int Y) {resize(X,Y,w_,h_);} diff --git a/documentation/Doxyfile b/documentation/Doxyfile index 06fa1d9dc..d8ca0507a 100644 --- a/documentation/Doxyfile +++ b/documentation/Doxyfile @@ -576,7 +576,7 @@ EXCLUDE_SYMBOLS = # directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = test +EXAMPLE_PATH = ../test # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp diff --git a/documentation/intro.dox b/documentation/intro.dox index 590e191d2..a2c7d89ca 100644 --- a/documentation/intro.dox +++ b/documentation/intro.dox @@ -315,25 +315,28 @@ make
The inherited destructor free all memory and server resources that are used by the image. +
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. -
\image html Fl_File_Chooser.jpg
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 @@
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. -
\image html Fl_Help_Dialog.gif
*/ /** \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.*/ - #includeThe destructor also deletes all the children. 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/10digits.*/
+/** Sets the step value to 1/10digits.*/
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 not
+ 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.
+ 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) {