diff options
| author | Fabien Costantini <fabien@onepost.net> | 2008-09-17 15:44:43 +0000 |
|---|---|---|
| committer | Fabien Costantini <fabien@onepost.net> | 2008-09-17 15:44:43 +0000 |
| commit | 3787be9b6e1a382a4482595ed9e1b17ad21e03fa (patch) | |
| tree | 226dd3d58511bfff50c964031510d08d76e2c1ce | |
| parent | b4a50239496145b3f07a6763b7092d477280b5cf (diff) | |
Doxygen documentation: replace all occurences in comments of " by a quote char. Temporarily set warn_if_undocumented to NO until we correct more severe messages.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6283 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
| -rw-r--r-- | FL/Fl.H | 22 | ||||
| -rw-r--r-- | FL/Fl_Adjuster.H | 4 | ||||
| -rw-r--r-- | FL/Fl_Box.H | 5 | ||||
| -rw-r--r-- | FL/Fl_Browser.H | 2 | ||||
| -rw-r--r-- | FL/Fl_Browser_.H | 2 | ||||
| -rw-r--r-- | FL/Fl_Free.H | 2 | ||||
| -rw-r--r-- | FL/Fl_Gl_Window.H | 4 | ||||
| -rw-r--r-- | FL/Fl_Input.H | 2 | ||||
| -rw-r--r-- | FL/Fl_Input_.H | 8 | ||||
| -rw-r--r-- | FL/Fl_Light_Button.H | 4 | ||||
| -rw-r--r-- | FL/Fl_Menu_Bar.H | 4 | ||||
| -rw-r--r-- | FL/Fl_Menu_Item.H | 40 | ||||
| -rw-r--r-- | FL/Fl_Overlay_Window.H | 4 | ||||
| -rw-r--r-- | FL/Fl_Roller.H | 2 | ||||
| -rw-r--r-- | FL/Fl_Round_Button.H | 4 | ||||
| -rw-r--r-- | FL/Fl_Scroll.H | 2 | ||||
| -rw-r--r-- | FL/Fl_Secret_Input.H | 2 | ||||
| -rw-r--r-- | FL/Fl_Slider.H | 2 | ||||
| -rw-r--r-- | FL/Fl_Tabs.H | 4 | ||||
| -rw-r--r-- | FL/Fl_Tile.H | 6 | ||||
| -rw-r--r-- | FL/Fl_Toggle_Button.H | 2 | ||||
| -rw-r--r-- | FL/Fl_Valuator.H | 6 | ||||
| -rw-r--r-- | FL/Fl_Value_Input.H | 4 | ||||
| -rw-r--r-- | FL/Fl_Value_Output.H | 4 | ||||
| -rw-r--r-- | FL/Fl_Widget.H | 4 | ||||
| -rw-r--r-- | FL/Fl_Window.H | 12 | ||||
| -rw-r--r-- | documentation/Doxyfile | 2 | ||||
| -rw-r--r-- | src/Fl_File_Chooser2.cxx | 3 | ||||
| -rw-r--r-- | src/Fl_Menu_.cxx | 2 | ||||
| -rw-r--r-- | src/Fl_Menu_add.cxx | 6 | ||||
| -rw-r--r-- | src/Fl_Overlay_Window.cxx | 2 | ||||
| -rw-r--r-- | src/forms_timer.cxx | 2 |
32 files changed, 86 insertions, 88 deletions
@@ -171,7 +171,7 @@ public: <p>If you need more accurate, repeated timeouts, use Fl::repeat_timeout() to reschedule the subsequent timeouts.</p> - <p>The following code will print "TICK" each second on + <p>The following code will print "TICK" each second on stdout with a fair degree of accuracy:</p> \code @@ -192,7 +192,7 @@ public: previous timeout, allowing for more accurate timing. You may only call this method inside a timeout callback. - <p>The following code will print "TICK" each second on + <p>The following code will print "TICK" each second on stdout with a fair degree of accuracy:</p> \code @@ -294,7 +294,7 @@ public: the passed window no matter where the pointer or focus is (including in other programs). The window <I>does not have to be shown()</I> , this lets the handle() method of a - "dummy" window override all event handling and allows you to + "dummy" window override all event handling and allows you to map and unmap a complex set of windows (under both X and WIN32 <I>some</I> window must be mapped because the system interface needs a window id). @@ -368,7 +368,7 @@ public: static void get_mouse(int &,int &); // platform dependent /** The first form returns non-zero if the most recent FL_PUSH or - FL_KEYBOARD was a "double click". Returns N-1 for + FL_KEYBOARD was a "double click". Returns N-1 for N clicks. A double click is counted if the same button is pressed again while event_is_click() is true. @@ -384,8 +384,8 @@ public: /** The first form returns non-zero if the mouse has not moved far enough and not enough time has passed since the last FL_PUSH or - FL_KEYBOARD event for it to be considered a "drag" rather than a - "click". You can test this on FL_DRAG, FL_RELEASE, + FL_KEYBOARD event for it to be considered a "drag" rather than a + "click". You can test this on FL_DRAG, FL_RELEASE, and FL_MOVE events. The second form clears the value returned by Fl::event_is_click(). Useful to prevent the <I>next</I> click from being counted as a double-click or to make a popup menu @@ -602,7 +602,7 @@ public: <P>The integer pointed to by attributes (if the pointer is not zero) is set to zero, FL_BOLD or FL_ITALIC or - FL_BOLD | FL_ITALIC. To locate a "family" of fonts, search + FL_BOLD | FL_ITALIC. To locate a "family" of fonts, search forward and back for a set with non-zero attributes, these faces along with the face with a zero attribute before them constitute a family. */ @@ -614,7 +614,7 @@ public: be matched exactly (fl_font() will pick the closest size for other sizes). A zero in the first location of the array indicates a scalable font, where any size works, although the array may list sizes - that work "better" than others. Warning: the returned array + that work "better" than others. Warning: the returned array points at a static buffer that is overwritten each call. Under X this will open the display. */ @@ -623,15 +623,15 @@ public: static void set_font(Fl_Font, Fl_Font); /** FLTK will open the display, and add every fonts on the server to the - face table. It will attempt to put "families" of faces together, so + face table. It will attempt to put "families" of faces together, so that the normal one is first, followed by bold, italic, and bold italic. <P>The optional argument is a string to describe the set of fonts to add. Passing NULL will select only fonts that have the ISO8859-1 character set (and are thus usable by normal text). Passing - "-*" will select all fonts with any encoding as long as they have - normal X font names with dashes in them. Passing "*" will list every + "-*" will select all fonts with any encoding as long as they have + normal X font names with dashes in them. Passing "*" will list every font that exists (on X this may produce some strange output). Other values may be useful but are system dependent. With WIN32 NULL selects fonts with ISO8859-1 encoding and non-NULL selects diff --git a/FL/Fl_Adjuster.H b/FL/Fl_Adjuster.H index 93ff3ecf5..7112cce73 100644 --- a/FL/Fl_Adjuster.H +++ b/FL/Fl_Adjuster.H @@ -59,14 +59,14 @@ protected: public: Fl_Adjuster(int X,int Y,int W,int H,const char *l=0); /** - If "soft" is turned on, the user is allowed to drag the value outside + If "soft" is turned on, the user is allowed to drag the value outside the range. If they drag the value to one of the ends, let go, then grab again and continue to drag, they can get to any value. Default is one. */ void soft(int s) {soft_ = s;} /** - If "soft" is turned on, the user is allowed to drag the value outside + If "soft" is turned on, the user is allowed to drag the value outside the range. If they drag the value to one of the ends, let go, then grab again and continue to drag, they can get to any value. Default is one. diff --git a/FL/Fl_Box.H b/FL/Fl_Box.H index 10644954a..97aa3285d 100644 --- a/FL/Fl_Box.H +++ b/FL/Fl_Box.H @@ -45,12 +45,13 @@ protected: void draw(); public: /** - The first constructor sets box() to FL_NO_BOX, which + - The first constructor sets box() to FL_NO_BOX, which means it is invisible. However such widgets are useful as placeholders or Fl_Group::resizable() values. To change the box to something visible, use box(n). - <P>The second form of the constructor sets the box to the specified box + - The second form of the constructor sets the box to the specified box type. + <P>The destructor removes the box. */ Fl_Box(int X, int Y, int W, int H, const char *l=0) : Fl_Widget(X,Y,W,H,l) {} diff --git a/FL/Fl_Browser.H b/FL/Fl_Browser.H index b1042d8fb..a31149c03 100644 --- a/FL/Fl_Browser.H +++ b/FL/Fl_Browser.H @@ -45,7 +45,7 @@ struct FL_BLINE; editor or spreadsheet! But it is useful for showing a vertical list of named objects to the user. <P>Each line in the browser is identified by number. <I>The numbers - start at one</I> (this is so that zero can be reserved for "no line" in + start at one</I> (this is so that zero can be reserved for "no line" in the selective browsers). <I>Unless otherwise noted, the methods do not check to see if the passed line number is in range and legal. It must always be greater than zero and <= size().</I></P> diff --git a/FL/Fl_Browser_.H b/FL/Fl_Browser_.H index d06b3b882..6fc2c1bf2 100644 --- a/FL/Fl_Browser_.H +++ b/FL/Fl_Browser_.H @@ -57,7 +57,7 @@ prev() functions are used to index, it works best as a linked list or as a large block of characters in which the line breaks must be searched for. </P> - <P>A great deal of work has been done so that the "height" of a data + <P>A great deal of work has been done so that the "height" of a data object does not need to be determined until it is drawn. This is useful if actually figuring out the size of an object requires accessing image data or doing stat() on a file or doing some diff --git a/FL/Fl_Free.H b/FL/Fl_Free.H index 16b04b397..313028096 100644 --- a/FL/Fl_Free.H +++ b/FL/Fl_Free.H @@ -44,7 +44,7 @@ typedef int (*FL_HANDLEPTR)(Fl_Widget *, int , float, float, char); /** - Emulation of the Forms "free" widget. This emulation allows the free + Emulation of the Forms "free" widget. This emulation allows the free demo to run, and appears to be useful for porting programs written in Forms which use the free widget or make subclasses of the Forms widgets. diff --git a/FL/Fl_Gl_Window.H b/FL/Fl_Gl_Window.H index 78b92091c..3bf95dd0f 100644 --- a/FL/Fl_Gl_Window.H +++ b/FL/Fl_Gl_Window.H @@ -41,7 +41,7 @@ class Fl_Gl_Choice; // structure to hold result of glXChooseVisual /** The Fl_Gl_Window widget sets things up so OpenGL works, and - also keeps an OpenGL "context" for that window, so that changes to the + also keeps an OpenGL "context" for that window, so that changes to the lighting and projection may be reused between redraws. Fl_Gl_Window also flushes the OpenGL streams and swaps buffers after draw() returns. @@ -149,7 +149,7 @@ public: <LI>FL_MULTISAMPLE - multisample antialiasing </LI> </UL> FL_RGB and FL_SINGLE have a value of zero, so they - are "on" unless you give FL_INDEX or FL_DOUBLE. + are "on" unless you give FL_INDEX or FL_DOUBLE. <P>If the desired combination cannot be done, FLTK will try turning off FL_MULTISAMPLE. If this also fails the show() will call Fl::error() and not show the window. </P> diff --git a/FL/Fl_Input.H b/FL/Fl_Input.H index 397f118d8..b820b2687 100644 --- a/FL/Fl_Input.H +++ b/FL/Fl_Input.H @@ -80,7 +80,7 @@ delete it.</TD></TR> <TR><TD><B>^Z or ^_</B></TD><TD>Undo. This is a single-level undo mechanism, but all adjacent deletions and insertions are concatenated - into a single "undo". Often this will undo a lot more than you + into a single "undo". Often this will undo a lot more than you expected.</TD></TR> <TR><TD><B>Shift+move</B></TD><TD>Move the cursor but also extend the selection.</TD></TR> diff --git a/FL/Fl_Input_.H b/FL/Fl_Input_.H index 210b3ff76..37a084e90 100644 --- a/FL/Fl_Input_.H +++ b/FL/Fl_Input_.H @@ -134,7 +134,7 @@ public: <P>The second two forms change the text and set the mark and the point to the end of it. The string is copied to the internal - buffer. Passing NULL is the same as "". + buffer. Passing NULL is the same as "". This returns non-zero if the new value is different than the current one. You can use the second version to directly set the length if you know it already or want to put nul's in the @@ -159,8 +159,8 @@ char index(int i) const {return value_[i];} void maximum_size(int m) {maximum_size_ = m;} /** The input widget maintains two pointers into the string. The - "position" is where the cursor is. The - "mark" is the other end of the selected text. If they + "position" is where the cursor is. The + "mark" is the other end of the selected text. If they are equal then there is no selection. Changing this does not affect the clipboard (use copy() to do that). @@ -222,7 +222,7 @@ char index(int i) const {return value_[i];} <P>The shift flags can be any set of values accepted by Fl::event_state(). If the bit is on that shift key must be pushed. Meta, Alt, Ctrl, and Shift must be off if they are not in - the shift flags (zero for the other bits indicates a "don't care" + the shift flags (zero for the other bits indicates a "don't care" setting). */ int shortcut() const {return shortcut_;} diff --git a/FL/Fl_Light_Button.H b/FL/Fl_Light_Button.H index 2a80567a2..e9600fe3d 100644 --- a/FL/Fl_Light_Button.H +++ b/FL/Fl_Light_Button.H @@ -34,8 +34,8 @@ #include "Fl_Button.H" /** - <P>This subclass displays the "on" state by turning on a light, - rather than drawing pushed in. The shape of the "light" + <P>This subclass displays the "on" state by turning on a light, + rather than drawing pushed in. The shape of the "light" is initially set to FL_DOWN_BOX. The color of the light when on is controlled with selection_color(), which defaults to FL_YELLOW. diff --git a/FL/Fl_Menu_Bar.H b/FL/Fl_Menu_Bar.H index 0b68b9a3a..96d02af57 100644 --- a/FL/Fl_Menu_Bar.H +++ b/FL/Fl_Menu_Bar.H @@ -46,14 +46,14 @@ of the submenus. </P> <P ALIGN=CENTER>\image html menubar.gif</P> <P>If there is an item in the top menu that is not a title of a - submenu, then it acts like a "button" in the menubar. Clicking on it + submenu, then it acts like a "button" in the menubar. Clicking on it will pick it. </P> <P>When the user picks an item off the menu, the item's callback is done with the menubar as the Fl_Widget* argument. If the item does not have a callback the menubar's callback is done instead. </P> <P>Submenus will also pop up in response to shortcuts indicated by putting a '&' character in the name field of the menu item. If you put a - '&' character in a top-level "button" then the shortcut picks it. The + '&' character in a top-level "button" then the shortcut picks it. The '&' character in submenus is ignored until the menu is popped up. </P> <P>Typing the shortcut() of any of the menu items will cause callbacks exactly the same as when you pick the item with the mouse. diff --git a/FL/Fl_Menu_Item.H b/FL/Fl_Menu_Item.H index 42cb96ee8..8b8fdcabd 100644 --- a/FL/Fl_Menu_Item.H +++ b/FL/Fl_Menu_Item.H @@ -82,22 +82,22 @@ class Fl_Menu_; Typically menu items are statically defined; for example: \code Fl_Menu_Item popup[] = { - {"&alpha", FL_ALT+'a', the_cb, (void*)1}, - {"&beta", FL_ALT+'b', the_cb, (void*)2}, - {"gamma", FL_ALT+'c', the_cb, (void*)3, FL_MENU_DIVIDER}, - {"&strange", 0, strange_cb}, - {"&charm", 0, charm_cb}, - {"&truth", 0, truth_cb}, - {"b&eauty", 0, beauty_cb}, - {"sub&menu", 0, 0, 0, FL_SUBMENU}, - {"one"}, - {"two"}, - {"three"}, + {"&alpha", FL_ALT+'a', the_cb, (void*)1}, + {"&beta", FL_ALT+'b', the_cb, (void*)2}, + {"gamma", FL_ALT+'c', the_cb, (void*)3, FL_MENU_DIVIDER}, + {"&strange", 0, strange_cb}, + {"&charm", 0, charm_cb}, + {"&truth", 0, truth_cb}, + {"b&eauty", 0, beauty_cb}, + {"sub&menu", 0, 0, 0, FL_SUBMENU}, + {"one"}, + {"two"}, + {"three"}, {0}, - {"inactive", FL_ALT+'i', 0, 0, FL_MENU_INACTIVE|FL_MENU_DIVIDER}, - {"invisible",FL_ALT+'i', 0, 0, FL_MENU_INVISIBLE}, - {"check", FL_ALT+'i', 0, 0, FL_MENU_TOGGLE|FL_MENU_VALUE}, - {"box", FL_ALT+'i', 0, 0, FL_MENU_TOGGLE}, + {"inactive", FL_ALT+'i', 0, 0, FL_MENU_INACTIVE|FL_MENU_DIVIDER}, + {"invisible",FL_ALT+'i', 0, 0, FL_MENU_INVISIBLE}, + {"check", FL_ALT+'i', 0, 0, FL_MENU_TOGGLE|FL_MENU_VALUE}, + {"box", FL_ALT+'i', 0, 0, FL_MENU_TOGGLE}, {0}}; \endcode produces: @@ -143,7 +143,7 @@ struct FL_EXPORT Fl_Menu_Item { This is the title of the item. A NULL here indicates the end of the menu (or of a submenu). A '&' in the item will print an underscore under the next letter, and if the menu is popped up that - letter will be a "shortcut" to pick that item. To get a + letter will be a "shortcut" to pick that item. To get a real '&' put two in a row. */ @@ -247,7 +247,7 @@ struct FL_EXPORT Fl_Menu_Item { <P>The shift flags can be any set of values accepted by Fl::event_state(). If the bit is on that shift key must be pushed. Meta, Alt, Ctrl, and Shift must be off if they are not in - the shift flags (zero for the other bits indicates a "don't care" + the shift flags (zero for the other bits indicates a "don't care" setting). */ void shortcut(int s) {shortcut_ = s;} @@ -267,7 +267,7 @@ struct FL_EXPORT Fl_Menu_Item { int checkbox() const {return flags&FL_MENU_TOGGLE;} /** Returns true if this item is a radio item. When a radio button is - selected all "adjacent" radio buttons are turned off. A set of radio + selected all "adjacent" radio buttons are turned off. A set of radio items is delimited by an item that has radio() false, or by an item with FL_MENU_DIVIDER turned on. */ @@ -275,12 +275,12 @@ struct FL_EXPORT Fl_Menu_Item { /** Returns the current value of the check or radio item. */ int value() const {return flags&FL_MENU_VALUE;} /** - Turns the check or radio item "on" for the menu item. Note that this + Turns the check or radio item "on" for the menu item. Note that this does not turn off any adjacent radio items like set_only() does. */ void set() {flags |= FL_MENU_VALUE;} - /** Turns the check or radio item "off" for the menu item. */ + /** Turns the check or radio item "off" for the menu item. */ void clear() {flags &= ~FL_MENU_VALUE;} void setonly(); /** Gets the visibility of an item. */ diff --git a/FL/Fl_Overlay_Window.H b/FL/Fl_Overlay_Window.H index 366a83bd6..af2a23c5e 100644 --- a/FL/Fl_Overlay_Window.H +++ b/FL/Fl_Overlay_Window.H @@ -35,13 +35,13 @@ /** This window provides double buffering and also the ability to draw the - "overlay" which is another picture placed on top of the main image. The + "overlay" which is another picture placed on top of the main image. The overlay is designed to be a rapidly-changing but simple graphic such as a mouse selection box. Fl_Overlay_Window uses the overlay planes provided by your graphics hardware if they are available. <P>If no hardware support is found the overlay is simulated by drawing directly into the on-screen copy of the double-buffered window, and - "erased" by copying the backbuffer over it again. This means the + "erased" by copying the backbuffer over it again. This means the overlay will blink if you change the image in the window. */ class FL_EXPORT Fl_Overlay_Window : public Fl_Double_Window { diff --git a/FL/Fl_Roller.H b/FL/Fl_Roller.H index cb2a59f56..71f26a4b1 100644 --- a/FL/Fl_Roller.H +++ b/FL/Fl_Roller.H @@ -36,7 +36,7 @@ #endif /** - The Fl_Roller widget is a "dolly" control commonly used to + The Fl_Roller widget is a "dolly" control commonly used to move 3D objects. <P ALIGN=CENTER>\image html Fl_Roller.gif */ diff --git a/FL/Fl_Round_Button.H b/FL/Fl_Round_Button.H index faa282a15..03e179c31 100644 --- a/FL/Fl_Round_Button.H +++ b/FL/Fl_Round_Button.H @@ -38,9 +38,9 @@ control exactly when and how by changing the values for type() and when(). <P ALIGN=CENTER>\image html Fl_Round_Button.gif</P> - <P>The Fl_Round_Button subclass display the "on" state by + <P>The Fl_Round_Button subclass display the "on" state by turning on a light, rather than drawing pushed in. The shape of the - "light" is initially set to FL_ROUND_DOWN_BOX. The color of the light + "light" is initially set to FL_ROUND_DOWN_BOX. The color of the light when on is controlled with selection_color(), which defaults to FL_RED. */ diff --git a/FL/Fl_Scroll.H b/FL/Fl_Scroll.H index 1e128b44b..5f0bc555e 100644 --- a/FL/Fl_Scroll.H +++ b/FL/Fl_Scroll.H @@ -69,7 +69,7 @@ considered. The flags in hscrollbar however are ignored. <P>This widget can also be used to pan around a single child widget - "canvas". This child widget should be of your own class, with a + "canvas". This child widget should be of your own class, with a draw() method that draws the contents. The scrolling is done by changing the x() and y() of the widget, so this child must use the x() and y() to position it's drawing. diff --git a/FL/Fl_Secret_Input.H b/FL/Fl_Secret_Input.H index fe0d349b1..cd5a7c9da 100644 --- a/FL/Fl_Secret_Input.H +++ b/FL/Fl_Secret_Input.H @@ -36,7 +36,7 @@ /** The Fl_Secret_Input class is a subclass of Fl_Input that displays its input as a string of asterisks. This subclass is - usually used to receive passwords and other "secret" information. + usually used to receive passwords and other "secret" information. */ class Fl_Secret_Input : public Fl_Input { public: diff --git a/FL/Fl_Slider.H b/FL/Fl_Slider.H index b4f72f361..1a54e9afe 100644 --- a/FL/Fl_Slider.H +++ b/FL/Fl_Slider.H @@ -93,7 +93,7 @@ public: Get or set the dimensions of the moving piece of slider. This is the fraction of the size of the entire widget. If you set this to 1 then the slider cannot move. The default value is .08. - <P>For the "fill" sliders this is the size of the area around the end + <P>For the "fill" sliders this is the size of the area around the end that causes a drag effect rather than causing the slider to jump to the mouse. */ diff --git a/FL/Fl_Tabs.H b/FL/Fl_Tabs.H index 7a1a873a9..a2e3d958c 100644 --- a/FL/Fl_Tabs.H +++ b/FL/Fl_Tabs.H @@ -34,7 +34,7 @@ #include "Fl_Group.H" /** - The Fl_Tabs widget is the "file card tabs" + The Fl_Tabs widget is the "file card tabs" interface that allows you to put lots and lots of buttons and switches in a panel, as popularized by many toolkits. @@ -54,7 +54,7 @@ <P>The size of the tabs is controlled by the bounding box of the children (there should be some space between the children and the edge of the Fl_Tabs), and the tabs may be placed - "inverted" on the bottom, this is determined by which + "inverted" on the bottom, this is determined by which gap is larger. It is easiest to lay this out in fluid, using the fluid browser to select each child group and resize them until the tabs look the way you want them to. diff --git a/FL/Fl_Tile.H b/FL/Fl_Tile.H index 66edebefc..73aa4bdf8 100644 --- a/FL/Fl_Tile.H +++ b/FL/Fl_Tile.H @@ -46,10 +46,10 @@ Fl_Tile. <P>Fl_Tile does not normailly draw any graphics of its own. - The "borders" which can be seen in the snapshot above + The "borders" which can be seen in the snapshot above are actually part of the children. Their boxtypes have been set to FL_DOWN_BOX creating the impression of - "ridges" where the boxes touch. What you see are + "ridges" where the boxes touch. What you see are actually two adjacent FL_DOWN_BOX's drawn next to each other. All neighboring widgets share the same edge - the widget's thick borders make it appear as though the widgets aren't actually @@ -68,7 +68,7 @@ want. <P>Note on resizable(Fl_Widget &w) : - The "resizable" child widget (which should be invisible) limits where the + The "resizable" child widget (which should be invisible) limits where the border can be dragged to. If you don't set it, it will be possible to drag the borders right to the edge, and thus resize objects on the edge to zero width or height. The resizable() widget is not diff --git a/FL/Fl_Toggle_Button.H b/FL/Fl_Toggle_Button.H index 8a37c7811..03ba2c806 100644 --- a/FL/Fl_Toggle_Button.H +++ b/FL/Fl_Toggle_Button.H @@ -36,7 +36,7 @@ /** The toggle button is a push button that needs to be clicked once to toggle on, and one more time to toggle off. - The Fl_Toggle_Button subclass displays the "on" state by + The Fl_Toggle_Button subclass displays the "on" state by drawing a pushed-in button.</P> <P>Buttons generate callbacks when they are clicked by the user. You control exactly when and how by changing the values for type() diff --git a/FL/Fl_Valuator.H b/FL/Fl_Valuator.H index 357094d60..a90e60223 100644 --- a/FL/Fl_Valuator.H +++ b/FL/Fl_Valuator.H @@ -48,7 +48,7 @@ <P>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 + widget. The ones labelled "0" are the default versions with a type(0). For consistency the symbol FL_VERTICAL is defined as zero. */ @@ -92,11 +92,11 @@ public: the step). <P>The minimum may be greater than the maximum. This has the - effect of "reversing" the object so the larger values + effect of "reversing" the object so the larger values are in the opposite direction. This also switches which end of the filled sliders is filled.</P> - <P>Some widgets consider this a "soft" range. This + <P>Some widgets consider this a "soft" range. This means they will stop at the range, but if the user releases and grabs the control again and tries to move it further, it is allowed.</P> diff --git a/FL/Fl_Value_Input.H b/FL/Fl_Value_Input.H index f30b900aa..f64a76b58 100644 --- a/FL/Fl_Value_Input.H +++ b/FL/Fl_Value_Input.H @@ -77,7 +77,7 @@ public: /** See void Fl_Value_Input::soft(char s) */ void soft(char s) {soft_ = s;} /** - If "soft" is turned on, the user is allowed to drag + If "soft" is turned on, the user is allowed to drag the value outside the range. If they drag the value to one of the ends, let go, then grab again and continue to drag, they can get to any value. The default is true. @@ -96,7 +96,7 @@ public: <P>The shift flags can be any set of values accepted by Fl::event_state(). If the bit is on that shift key must be pushed. Meta, Alt, Ctrl, and Shift must be off if they are not in - the shift flags (zero for the other bits indicates a "don't care" + the shift flags (zero for the other bits indicates a "don't care" setting). */ int shortcut() const {return input.shortcut();} diff --git a/FL/Fl_Value_Output.H b/FL/Fl_Value_Output.H index 0a05f0867..266c08bd5 100644 --- a/FL/Fl_Value_Output.H +++ b/FL/Fl_Value_Output.H @@ -57,14 +57,14 @@ public: Fl_Value_Output(int x,int y,int w,int h,const char *l=0); /** - If "soft" is turned on, the user is allowed to drag the value outside + If "soft" is turned on, the user is allowed to drag the value outside the range. If they drag the value to one of the ends, let go, then grab again and continue to drag, they can get to any value. Default is one. */ void soft(uchar s) {soft_ = s;} /** - If "soft" is turned on, the user is allowed to drag the value outside + If "soft" is turned on, the user is allowed to drag the value outside the range. If they drag the value to one of the ends, let go, then grab again and continue to drag, they can get to any value. Default is one. diff --git a/FL/Fl_Widget.H b/FL/Fl_Widget.H index 7e1b1fa98..67741b228 100644 --- a/FL/Fl_Widget.H +++ b/FL/Fl_Widget.H @@ -474,7 +474,7 @@ public: * If no tooltip is set, the tooltip of the parent is inherited. Setting a * tooltip for a group and setting no tooltip for a child will show the * group's tooltip instead. To avoid this behavior, you can set the child's - * tooltip to an empty string (""). + * tooltip to an empty string (""). * \param[in] t new tooltip */ void tooltip(const char *t); @@ -580,7 +580,7 @@ public: * is zero then the callback is never done. Other values are described * in the individual widgets. This field is in the base class so that * you can scan a panel and do_callback() on all the ones that - * don't do their own callbacks in response to an "OK" button. + * don't do their own callbacks in response to an "OK" button. * \param[in] i set of flags */ void when(uchar i) {when_ = i;} diff --git a/FL/Fl_Window.H b/FL/Fl_Window.H index cd2d13b53..f6561741e 100644 --- a/FL/Fl_Window.H +++ b/FL/Fl_Window.H @@ -41,7 +41,7 @@ class Fl_X; /** This widget produces an actual window. This can either be a main window, with a border and title and all the window management controls, - or a "subwindow" inside a window. This is controlled by whether or not + or a "subwindow" inside a window. This is controlled by whether or not the window has a parent(). <P>Once you create a window, you usually add children Fl_Widget 's to it by using window->add(child) for each new widget. See Fl_Group for more information @@ -174,10 +174,10 @@ public: /** Returns non zero if FL_OVERRIDE flag is set, 0 otherwise. */ int override() const { return flags()&FL_OVERRIDE; } /** - A "modal" window, when shown(), will prevent any events from + A "modal" window, when shown(), will prevent any events from being delivered to other windows in the same program, and will also remain on top of the other windows (if the X window manager supports - the "transient for" property). Several modal windows may be shown at + the "transient for" property). Several modal windows may be shown at once, in which case only the last one shown gets events. You can See which window (if any) is modal by calling Fl::modal(). @@ -188,7 +188,7 @@ public: */ int modal() const {return flags() & FL_MODAL;} /** - A "non-modal" window (terminology borrowed from Microsoft Windows) + A "non-modal" window (terminology borrowed from Microsoft Windows) acts like a modal() one in that it remains on top, but it has no effect on event delivery. There are <I>three</I> states for a window: modal, non-modal, and normal. @@ -285,8 +285,8 @@ public: this identifies the picture to draw in the icon. <I>Under X, this is turned into a XA_WM_CLASS pair by truncating at the first non-alphanumeric character and capitalizing the first character, and - the second one if the first is 'x'. Thus "foo" turns into "foo, Foo", - and "xprog.1" turns into "xprog, XProg".</I> This only works if called <I> + the second one if the first is 'x'. Thus "foo" turns into "foo, Foo", + and "xprog.1" turns into "xprog, XProg".</I> This only works if called <I> before</I> calling show(). <P>Under Microsoft Windows this string is used as the name of the WNDCLASS structure, though it is not clear if this can have any diff --git a/documentation/Doxyfile b/documentation/Doxyfile index a2da48363..b0abd2a17 100644 --- a/documentation/Doxyfile +++ b/documentation/Doxyfile @@ -472,7 +472,7 @@ WARNINGS = YES # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. -WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = NO # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some diff --git a/src/Fl_File_Chooser2.cxx b/src/Fl_File_Chooser2.cxx index 7bf9b6305..9cf693a1f 100644 --- a/src/Fl_File_Chooser2.cxx +++ b/src/Fl_File_Chooser2.cxx @@ -265,9 +265,6 @@ /** \fn const char *Fl_File_Chooser::value(int file) See const char *value(const char *pathname)*/ -/** \fn const char *Fl_File_Chooser::value() - See const char *value(const char *pathname)*/ - /** \fn int Fl_File_Chooser::visible() Returns 1 if the Fl_File_Chooser window is visible.*/ diff --git a/src/Fl_Menu_.cxx b/src/Fl_Menu_.cxx index 7da9943ee..3701ea1d0 100644 --- a/src/Fl_Menu_.cxx +++ b/src/Fl_Menu_.cxx @@ -156,7 +156,7 @@ const Fl_Menu_Item* Fl_Menu_::picked(const Fl_Menu_Item* v) { return v; } -/** Turns the radio item "on" for the menu item and turns off adjacent radio items set. */ +/** Turns the radio item "on" for the menu item and turns off adjacent radio items set. */ void Fl_Menu_Item::setonly() { flags |= FL_MENU_RADIO | FL_MENU_VALUE; Fl_Menu_Item* j; diff --git a/src/Fl_Menu_add.cxx b/src/Fl_Menu_add.cxx index c7ef5a4aa..b100fcdc8 100644 --- a/src/Fl_Menu_add.cxx +++ b/src/Fl_Menu_add.cxx @@ -189,9 +189,9 @@ int Fl_Menu_Item::add( character in the string. Labels starting with the "_" character cause a divider to be placed after that menu item.</p> - <p>A label of the form "foo/bar/baz" will create a - submenus called "foo" and "bar" with an - entry called "baz". The "/" character is ignored if it + <p>A label of the form "foo/bar/baz" will create a + submenus called "foo" and "bar" with an + entry called "baz". The "/" character is ignored if it appears as the first character of the label string, e.g. "/foo/bar/baz".</p> diff --git a/src/Fl_Overlay_Window.cxx b/src/Fl_Overlay_Window.cxx index 664759f47..fd4fdfdcc 100644 --- a/src/Fl_Overlay_Window.cxx +++ b/src/Fl_Overlay_Window.cxx @@ -28,7 +28,7 @@ /** \fn virtual void Fl_Overlay_Window::draw_overlay() = 0 You must subclass Fl_Overlay_Window and provide this method. It is just like a draw() method, except it draws the overlay. - The overlay will have already been "cleared" when this is called. You + The overlay will have already been "cleared" when this is called. You can use any of the routines described in <FL/fl_draw.H>. */ diff --git a/src/forms_timer.cxx b/src/forms_timer.cxx index 69d01c384..ad4444572 100644 --- a/src/forms_timer.cxx +++ b/src/forms_timer.cxx @@ -139,7 +139,7 @@ Fl_Timer::~Fl_Timer() { following symbolic constants: <UL> <LI>FL_NORMAL_TIMER - The timer just does the callback and - displays the string "Timer" in the widget. </LI> + displays the string "Timer" in the widget. </LI> <LI>FL_VALUE_TIMER - The timer does the callback and displays the current timer value in the widget. </LI> <LI>FL_HIDDEN_TIMER - The timer just does the callback and |