Fixed typos and doxygen documentation.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6582 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

19 files changed, 65 insertions, 57 deletions

diff --git a/src/Fl_Browser.cxx b/src/Fl_Browser.cxx
index b519c0f92..84e0d69cd 100644
--- a/src/Fl_Browser.cxx
+++ b/src/Fl_Browser.cxx
@@ -34,12 +34,11 @@
 
 // I modified this from the original Forms data to use a linked list
 // so that the number of items in the browser and size of those items
-// is unlimited.  The only problem is that the old browser used an
+// is unlimited. The only problem is that the old browser used an
 // index number to identify a line, and it is slow to convert from/to
-// a pointer.  I use a cache of the last match to try to speed this
-// up.
+// a pointer. I use a cache of the last match to try to speed this up.
 
-// Also added the ability to "hide" a line.  This set's it's height to
+// Also added the ability to "hide" a line. This sets its height to
 // zero, so the Fl_Browser_ cannot pick it.
 
 #define SELECTED 1
@@ -69,7 +68,7 @@ void Fl_Browser::item_select(void* l, int v) {
 }
 
 /**
-  Return entry for line number \p line.
+  Return entry for line number \a line.
 */
 FL_BLINE* Fl_Browser::find_line(int line) const {
   int n; FL_BLINE* l;
@@ -89,7 +88,7 @@ FL_BLINE* Fl_Browser::find_line(int line) const {
 }
 
 /**
-  Returns line number corresponding to data \p v,
+  Returns line number corresponding to data \a v,
   zero if not found.
 */
 int Fl_Browser::lineno(void* v) const {
@@ -141,7 +140,7 @@ FL_BLINE* Fl_Browser::_remove(int line) {
 }
 
 /**
-  Remove line n and make the browser one line shorter.
+  Remove line \a line and make the browser one line shorter.
 */
 void Fl_Browser::remove(int line) {
   if (line < 1 || line > lines) return;
@@ -149,8 +148,8 @@ void Fl_Browser::remove(int line) {
 }
 
 /**
-  Insert a new line \p t \e before line \p n.  If \p n &gt; 
-  size() then the line is added to the end.
+  Insert a new line \a t \e before line \a n.
+  If \a n > size() then the line is added to the end.
 */
 void Fl_Browser::insert(int line, FL_BLINE* t) {
   if (!first) {
@@ -184,7 +183,7 @@ void Fl_Browser::insert(int line, FL_BLINE* t) {
 
 /**
   Insert a new entry \e before given line.
-  \param[in] line if \p line > size(), the entry will be added at the end.
+  \param[in] line if \a line > size(), the entry will be added at the end.
   \param[in] newtext text entry for the new line.
   \param[in] d pointer to data associated with the new line.
 */
@@ -199,7 +198,7 @@ void Fl_Browser::insert(int line, const char* newtext, void* d) {
 }
 
 /**
-  Line from is removed and reinserted at to; to
+  Line \a from is removed and reinserted at \a to; \a to
   is calculated after the line is removed.
 */
 void Fl_Browser::move(int to, int from) {
@@ -208,8 +207,8 @@ void Fl_Browser::move(int to, int from) {
 }
 
 /**
-  Sets the text for line \p line to text \p newtext.
-  Does nothing if \p line is out of range.
+  Sets the text for line \a line to text \a newtext.
+  Does nothing if \a line is out of range.
 */
 void Fl_Browser::text(int line, const char* newtext) {
   if (line < 1 || line > lines) return;
@@ -234,8 +233,8 @@ void Fl_Browser::text(int line, const char* newtext) {
 }
 
 /**
-  Sets the data for line \p n to \p d.
-  Does nothing if \n is out of range.
+  Sets the data for line \a line to \a d.
+  Does nothing if \a line is out of range.
 */
 void Fl_Browser::data(int line, void* d) {
   if (line < 1 || line > lines) return;
@@ -300,7 +299,7 @@ int Fl_Browser::item_width(void* v) const {
   const int* i = column_widths();
   int ww = 0;
 
-  while (*i) { // add up all tab-seperated fields
+  while (*i) { // add up all tab-separated fields
     char* e;
     e = strchr(str, column_char());
     if (!e) break; // last one occupied by text
@@ -357,7 +356,7 @@ void Fl_Browser::item_draw(void* v, int X, int Y, int W, int H) const {
   char* str = ((FL_BLINE*)v)->txt;
   const int* i = column_widths();
 
-  while (W > 6) {	// do each tab-seperated field
+  while (W > 6) {	// do each tab-separated field
     int w1 = W;	// width for this field
     char* e = 0; // pointer to end of field or null if none
     if (*i) { // find end of field and temporarily replace with 0
@@ -423,7 +422,7 @@ void Fl_Browser::item_draw(void* v, int X, int Y, int W, int H) const {
     fl_color(lcol);
     fl_draw(str, X+3, Y, w1-6, H, e ? Fl_Align(talign|FL_ALIGN_CLIP) : talign, 0, 0);
     if (!e) break; // no more fields...
-    *e = column_char(); // put the seperator back
+    *e = column_char(); // put the separator back
     X += w1;
     W -= w1;
     str = e+1;
@@ -437,7 +436,7 @@ static const int no_columns[1] = {0};
   \param[in] X,Y,W,H position and size.
   \param[in] L label string, may be NULL.
 */
-Fl_Browser::Fl_Browser(int X, int Y, int W, int H, const char*L)
+Fl_Browser::Fl_Browser(int X, int Y, int W, int H, const char *L)
 : Fl_Browser_(X, Y, W, H, L) {
   column_widths_ = no_columns;
   lines = 0;
@@ -449,7 +448,7 @@ Fl_Browser::Fl_Browser(int X, int Y, int W, int H, const char*L)
 }
 
 /**
-  Update browser so that line is shown at given position.
+  Updates the browser so that \a line is shown at position \pos.
   \param[in] line line number.
   \param[in] pos position.
 */
@@ -486,7 +485,7 @@ int Fl_Browser::topline() const {
 }
 
 /**
-  Remove all the lines in the browser.
+  Removes all the lines in the browser.
 */
 void Fl_Browser::clear() {
   for (FL_BLINE* l = first; l;) {
@@ -501,9 +500,9 @@ void Fl_Browser::clear() {
 }
 
 /**
-  Add a new line to the end of the browser.  The text is copied using
+  Adds a new line to the end of the browser.  The text is copied using
   the strdup() function.  It may also be NULL to make a
-  blank line.  The void * argument is returned as the data()
+  blank line.  The void * argument \a d is returned as the data()
   of the new item.
 */
 void Fl_Browser::add(const char* newtext, void* d) {
@@ -520,7 +519,7 @@ const char* Fl_Browser::text(int line) const {
 }
 
 /**
-  Returns the data for line \p n, or NULL is \p n is out of range.
+  Returns the data for line \p line, or NULL if \p line is out of range.
 */
 void* Fl_Browser::data(int line) const {
   if (line < 1 || line > lines) return 0;
@@ -528,7 +527,7 @@ void* Fl_Browser::data(int line) const {
 }
 
 /**
-  Sets the selection state of entry.
+  Sets the selection state of entry \a line.
   \param[in] line line number.
   \param[in] v new selection state.
   \returns 1 if the state changed, 0 if not.
@@ -538,13 +537,13 @@ int Fl_Browser::select(int line, int v) {
   return Fl_Browser_::select(find_line(line), v);
 }
 
-/**  Return 1 if line n is selected, 0 if it not selected.*/
+/**  Returns 1 if line \a line is selected, 0 if it is not selected.*/
 int Fl_Browser::selected(int line) const {
   if (line < 1 || line > lines) return 0;
   return find_line(line)->flags & SELECTED;
 }
 
-/**  Makes line n visible for selection.*/
+/**  Makes line \a line visible for selection. */
 void Fl_Browser::show(int line) {
   FL_BLINE* t = find_line(line);
   if (t->flags & NOTDISPLAYED) {
@@ -555,7 +554,7 @@ void Fl_Browser::show(int line) {
 }
 
 /**
-  Makes line n invisible, preventing selection by the user.
+  Makes line \a line invisible, preventing selection by the user.
   The line can still be selected under program control.
 */
 void Fl_Browser::hide(int line) {
@@ -569,6 +568,9 @@ void Fl_Browser::hide(int line) {
 
 /**
   For back compatibility.
+  
+  This calls show(line) if \a v is true, and hide(line) otherwise.
+  \see show(int line), hide(int line)
 */
 void Fl_Browser::display(int line, int v) {
   if (line < 1 || line > lines) return;
@@ -576,7 +578,7 @@ void Fl_Browser::display(int line, int v) {
 }
 
 /**
-  Returns a non-zero value if line is visible.
+  Returns a non-zero value if line \a line is visible.
 */
 int Fl_Browser::visible(int line) const {
   if (line < 1 || line > lines) return 0;
@@ -584,7 +586,7 @@ int Fl_Browser::visible(int line) const {
 }
 
 /**
-  Gets browser value.
+  Gets the browser's value.
   \returns line number of current selection, or 0 if no selection.
 */
 int Fl_Browser::value() const {
diff --git a/src/Fl_Gl_Overlay.cxx b/src/Fl_Gl_Overlay.cxx
index f9a2c7bed..433de4a88 100644
--- a/src/Fl_Gl_Overlay.cxx
+++ b/src/Fl_Gl_Overlay.cxx
@@ -43,7 +43,7 @@ void Fl_Gl_Window::make_overlay() {overlay = this;}
 #else
 
 // Methods on Fl_Gl_Window that create an overlay window.  Because
-// many programs don't need the overlay, this is seperated into this
+// many programs don't need the overlay, this is separated into this
 // source file so it is not linked in if not used.
 
 // Under X this is done by creating another window, of class _Fl_Gl_Overlay
diff --git a/src/Fl_Gl_Window.cxx b/src/Fl_Gl_Window.cxx
index db6fe011d..a7a98f5bc 100644
--- a/src/Fl_Gl_Window.cxx
+++ b/src/Fl_Gl_Window.cxx
@@ -336,7 +336,7 @@ void Fl_Gl_Window::flush() {
       if (overlay == this) {
 	// don't draw if only the overlay is damaged:
 	if (damage1_ || damage() != FL_DAMAGE_OVERLAY || !save_valid) draw();
-	// we use a seperate context for the copy because rasterpos must be 0
+	// we use a separate context for the copy because rasterpos must be 0
 	// and depth test needs to be off:
 	static GLContext ortho_context = 0;
 	static Fl_Gl_Window* ortho_window = 0;
diff --git a/src/Fl_Menu_add.cxx b/src/Fl_Menu_add.cxx
index b100fcdc8..3cc0e8797 100644
--- a/src/Fl_Menu_add.cxx
+++ b/src/Fl_Menu_add.cxx
@@ -273,7 +273,7 @@ int Fl_Menu_::add(const char *t, int s, Fl_Callback *c,void *v,int f) {
 
 /**
   This is a Forms (and SGI GL library) compatible add function, it
-  adds many menu items, with '|' seperating the menu items, and tab
+  adds many menu items, with '|' separating the menu items, and tab
   separating the menu item names from an optional shortcut string.
 
   The passed string is split at any '|' characters and then
diff --git a/src/Fl_Preferences.cxx b/src/Fl_Preferences.cxx
index f96f90ccb..43f3002ff 100644
--- a/src/Fl_Preferences.cxx
+++ b/src/Fl_Preferences.cxx
@@ -107,7 +107,7 @@ Fl_Preferences::Fl_Preferences( const char *path, const char *vendor, const char
 
    Use the \a group argument to name the group that you would like to access.
    \a Group can also contain a path to a group further down the hierarchy by
-   seperating group names with a forward slash '/'. 
+   separating group names with a forward slash '/'. 
 
    \param[in] parent reference object for the new group
    \param[in] group name of the group to access (may contain '/'s)
diff --git a/src/Fl_Tabs.cxx b/src/Fl_Tabs.cxx
index fac59eef7..9877beb28 100644
--- a/src/Fl_Tabs.cxx
+++ b/src/Fl_Tabs.cxx
@@ -29,7 +29,7 @@
 // This is the "file card tabs" interface to allow you to put lots and lots
 // of buttons and switches in a panel, as popularized by many toolkits.
 
-// Each child widget is a card, and it's label() is printed on the card tab.
+// Each child widget is a card, and its label() is printed on the card tab.
 // Clicking the tab makes that card visible.
 
 #include <stdio.h>
@@ -43,7 +43,7 @@
 
 // return the left edges of each tab (plus a fake left edge for a tab
 // past the right-hand one).  These position are actually of the left
-// edge of the slope.  They are either seperated by the correct distance
+// edge of the slope.  They are either separated by the correct distance
 // or by EXTRASPACE or by zero.
 // Return value is the index of the selected item.
 
@@ -411,7 +411,7 @@ void Fl_Tabs::draw_tab(int x1, int x2, int W, int H, Fl_Widget* o, int what) {
     <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_Tabs and all of it's children
+    has been done so the Fl_Tabs and all of its children
     can be automatic (local) variables, but you must declare the
     Fl_Tabs widget <I>first</I> so that it is destroyed last.
 */
diff --git a/src/Fl_Widget.cxx b/src/Fl_Widget.cxx
index b0df5afa0..b0c9ce694 100644
--- a/src/Fl_Widget.cxx
+++ b/src/Fl_Widget.cxx
@@ -64,8 +64,8 @@ void Fl_Widget::default_callback(Fl_Widget *o, void * /*v*/) {
 }
 /**
     All Fl_Widgets that don't have a callback defined use a
-    default callback that puts a pointer to the widget in this queue, and
-    this method reads the oldest widget out of this queue.
+    default callback that puts a pointer to the widget in this queue,
+    and this method reads the oldest widget out of this queue.
 */
 Fl_Widget *Fl::readqueue() {
   if (obj_tail==obj_head) return 0;
@@ -80,7 +80,7 @@ int Fl_Widget::handle(int) {
   return 0;
 }
 
-/** default font size for widgets */
+/** Default font size for widgets */
 Fl_Fontsize FL_NORMAL_SIZE = 14;
 
 Fl_Widget::Fl_Widget(int X, int Y, int W, int H, const char* L) {
@@ -147,7 +147,7 @@ Fl_Widget::~Fl_Widget() {
   fl_throw_focus(this);
 }
 
-/** Draws a focus box for the widget at position X,Y and SIZE W,H . */
+/** Draws a focus box for the widget at position X,Y with size W,H. */
 void
 Fl_Widget::draw_focus(Fl_Boxtype B, int X, int Y, int W, int H) const {
   if (!Fl::visible_focus()) return;
diff --git a/src/Fl_mac.cxx b/src/Fl_mac.cxx
index b56a949ee..7edb07bea 100644
--- a/src/Fl_mac.cxx
+++ b/src/Fl_mac.cxx
@@ -1833,7 +1833,7 @@ static OSErr fillCurrentDragData(DragReference dragRef)
       GetFlavorDataSize( dragRef, itemRef, 'TEXT', &itemSize );
       GetFlavorData( dragRef, itemRef, 'TEXT', dst, &itemSize, 0L );
       dst += itemSize;
-      *dst++ = '\n'; // add our element seperator
+      *dst++ = '\n'; // add our element separator
     }
     ret = GetFlavorFlags( dragRef, itemRef, 'hfs ', &flags );
     if ( ret == noErr )
@@ -1844,7 +1844,7 @@ static OSErr fillCurrentDragData(DragReference dragRef)
       dst += itemSize;
       if ( itemSize>1 && ( hfs.fileType=='fold' || hfs.fileType=='disk' ) ) 
         *dst++ = '/';
-      *dst++ = '\n'; // add our element seperator
+      *dst++ = '\n'; // add our element separator
     }
   }
 
diff --git a/src/fl_boxtype.cxx b/src/fl_boxtype.cxx
index 3cac9d21d..dd397782c 100644
--- a/src/fl_boxtype.cxx
+++ b/src/fl_boxtype.cxx
@@ -31,7 +31,7 @@
 */
 
 // Box drawing code for the common box types and the table of
-// boxtypes.  Other box types are in seperate files so they are not
+// boxtypes.  Other box types are in separate files so they are not
 // linked in if not used.
 
 #include <FL/Fl.H>
diff --git a/src/fl_diamond_box.cxx b/src/fl_diamond_box.cxx
index d9183b6f5..4da503b0f 100644
--- a/src/fl_diamond_box.cxx
+++ b/src/fl_diamond_box.cxx
@@ -26,7 +26,7 @@
 //
 
 // Box drawing code for an obscure box type.
-// These box types are in seperate files so they are not linked
+// These box types are in separate files so they are not linked
 // in if not used.
 
 // The diamond box draws best if the area is square!
diff --git a/src/fl_dnd_win32.cxx b/src/fl_dnd_win32.cxx
index 26fd47bb4..cab08175b 100644
--- a/src/fl_dnd_win32.cxx
+++ b/src/fl_dnd_win32.cxx
@@ -233,7 +233,7 @@ private:
     fmt.dwAspect = DVASPECT_CONTENT;
     fmt.lindex = -1;
     fmt.cfFormat = CF_HDROP;
-    // if it is a pathname list, send an FL_PASTE with a \n seperated list of filepaths
+    // if it is a pathname list, send an FL_PASTE with a \n separated list of filepaths
     if ( data->GetData( &fmt, &medium )==S_OK )
     {
       HDROP hdrop = (HDROP)medium.hGlobal;
diff --git a/src/fl_draw_image_win32.cxx b/src/fl_draw_image_win32.cxx
index 05fc7ee8c..f688a6e1d 100644
--- a/src/fl_draw_image_win32.cxx
+++ b/src/fl_draw_image_win32.cxx
@@ -39,7 +39,7 @@
 // Micro$oft picked a bottom-up and BGR storage format for their
 // DIB images.  I'm pretty certain there is a way around this, but
 // I can't find any other than the brute-force method of drawing
-// each line as a seperate image.  This may also need to be done
+// each line as a separate image.  This may also need to be done
 // if the delta is any amount other than 1, 3, or 4.
 
 ////////////////////////////////////////////////////////////////
diff --git a/src/fl_font_xft.cxx b/src/fl_font_xft.cxx
index 341a6faad..e6ddbdd3e 100644
--- a/src/fl_font_xft.cxx
+++ b/src/fl_font_xft.cxx
@@ -36,7 +36,7 @@
 // available to use this code.  You will just get normal Xlib fonts
 // (Xft calls them "core" fonts) The Xft algorithms for choosing
 // these is about as good as the FLTK ones (I hope to fix it so it is
-// exactly as good...), plus it can cache it's results and share them
+// exactly as good...), plus it can cache its results and share them
 // between programs, so using this should be a win in all cases. Also
 // it should be obvious by comparing this file and fl_font_x.cxx that
 // it is a lot easier to program with Xft than with Xlib.
@@ -172,7 +172,7 @@ static XftFont* fontopen(const char* name, bool core) {
       char *curr = local_name; // points to first name in string
       char *nxt; // next name in string
       do {
-        nxt = strchr(curr, ','); // find comma seperator
+        nxt = strchr(curr, ','); // find comma separator
         if (nxt) {
           *nxt = 0; // terminate first name
           nxt++; // first char of next name
diff --git a/src/fl_gtk.cxx b/src/fl_gtk.cxx
index c0930c63b..91b1584f3 100644
--- a/src/fl_gtk.cxx
+++ b/src/fl_gtk.cxx
@@ -29,7 +29,7 @@
 //
 
 // Box drawing code for an obscure box type.
-// These box types are in seperate files so they are not linked
+// These box types are in separate files so they are not linked
 // in if not used.
 
 #include <FL/Fl.H>
diff --git a/src/fl_labeltype.cxx b/src/fl_labeltype.cxx
index c7116855e..0c3ecd894 100644
--- a/src/fl_labeltype.cxx
+++ b/src/fl_labeltype.cxx
@@ -102,7 +102,9 @@ void Fl_Label::measure(int& W, int& H) const {
   f(this, W, H);
 }
 
-/** The normal call for a draw() method */
+/** Draws the widget's label at the defined label position.
+    This is the normal call for a widget's draw() method.
+ */
 void Fl_Widget::draw_label() const {
   int X = x_+Fl::box_dx(box());
   int W = w_-Fl::box_dw(box());
@@ -110,14 +112,18 @@ void Fl_Widget::draw_label() const {
   draw_label(X, y_+Fl::box_dy(box()), W, h_-Fl::box_dh(box()));
 }
 
-/** draw() can use this instead to change the bounding box */
+/** Draws the label in an arbitrary bounding box.
+    draw() can use this instead of draw_label(void) to change the bounding box
+ */
 void Fl_Widget::draw_label(int X, int Y, int W, int H) const {
   // quit if we are not drawing a label inside the widget:
   if ((align()&15) && !(align() & FL_ALIGN_INSIDE)) return;
   draw_label(X,Y,W,H,align());
 }
 
-/** Anybody can call this to force the label to draw anywhere */
+/** Draws the label in an arbitrary bounding box with an arbitrary alignment.
+    Anybody can call this to force the label to draw anywhere.
+ */
 void Fl_Widget::draw_label(int X, int Y, int W, int H, Fl_Align a) const {
   if (flags()&SHORTCUT_LABEL) fl_draw_shortcut = 1;
   Fl_Label l1 = label_;
diff --git a/src/fl_oval_box.cxx b/src/fl_oval_box.cxx
index f9cbb1fc8..7d30a4069 100644
--- a/src/fl_oval_box.cxx
+++ b/src/fl_oval_box.cxx
@@ -26,7 +26,7 @@
 //
 
 
-// Less-used box types are in seperate files so they are not linked
+// Less-used box types are in separate files so they are not linked
 // in if not used.
 
 #include <FL/Fl.H>
diff --git a/src/fl_plastic.cxx b/src/fl_plastic.cxx
index 86216e3cc..873ddab86 100644
--- a/src/fl_plastic.cxx
+++ b/src/fl_plastic.cxx
@@ -29,7 +29,7 @@
 //
 
 // Box drawing code for an obscure box type.
-// These box types are in seperate files so they are not linked
+// These box types are in separate files so they are not linked
 // in if not used.
 
 #include <FL/Fl.H>
diff --git a/src/fl_round_box.cxx b/src/fl_round_box.cxx
index 275012481..914e348e9 100644
--- a/src/fl_round_box.cxx
+++ b/src/fl_round_box.cxx
@@ -26,7 +26,7 @@
 //
 
 // Box drawing code for an obscure box type.
-// These box types are in seperate files so they are not linked
+// These box types are in separate files so they are not linked
 // in if not used.
 
 #include <FL/Fl.H>
diff --git a/src/fl_set_fonts_x.cxx b/src/fl_set_fonts_x.cxx
index 8f93aa54f..acbb8c8df 100644
--- a/src/fl_set_fonts_x.cxx
+++ b/src/fl_set_fonts_x.cxx
@@ -112,7 +112,7 @@ const char* Fl::get_font_name(Fl_Font fnum, int* ap) {
       }
       *o = 0;
 
-    } else { // standard dash-seperated font:
+    } else { // standard dash-separated font:
 
       // get the family:
       const char *x = fl_font_word(p,2); if (*x) x++; if (*x=='*') x++;