Doxygen documentation. Fixed somes typos and also H4 remanent misplaced tags and comments.

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

15 files changed, 28 insertions, 29 deletions

diff --git a/src/Fl.cxx b/src/Fl.cxx
index 5d2f30e54..92183b54b 100644
--- a/src/Fl.cxx
+++ b/src/Fl.cxx
@@ -1327,7 +1327,7 @@ int Fl_Window::handle(int ev)
 }
 
 ////////////////////////////////////////////////////////////////
-// Back compatability cut & paste functions for fltk 1.1 only:
+// Back compatibility cut & paste functions for fltk 1.1 only:
 
 /**
     The single-argument selection_owner(x) call can be used to
diff --git a/src/Fl_Browser_.cxx b/src/Fl_Browser_.cxx
index 2bc6ce99f..d25655e25 100644
--- a/src/Fl_Browser_.cxx
+++ b/src/Fl_Browser_.cxx
@@ -889,7 +889,7 @@ Fl_Browser_::Fl_Browser_(int X, int Y, int W, int H, const char* l)
   selection_ = 0;
   color(FL_BACKGROUND2_COLOR, FL_SELECTION_COLOR);
   scrollbar.callback(scrollbar_callback);
-//scrollbar.align(FL_ALIGN_LEFT|FL_ALIGN_BOTTOM); // back compatability?
+//scrollbar.align(FL_ALIGN_LEFT|FL_ALIGN_BOTTOM); // back compatibility?
   hscrollbar.callback(hscrollbar_callback);
   hscrollbar.type(FL_HORIZONTAL);
   textfont_ = FL_HELVETICA;
diff --git a/src/Fl_Check_Button.cxx b/src/Fl_Check_Button.cxx
index 54fb02850..addd33d38 100644
--- a/src/Fl_Check_Button.cxx
+++ b/src/Fl_Check_Button.cxx
@@ -30,7 +30,7 @@
 
 // A subclass of Fl_Button that always draws as a diamond box.  This
 // diamond is smaller than the widget size and can be surchecked by
-// another box type, for compatability with Forms.
+// another box type, for compatibility with Forms.
 
 Fl_Check_Button::Fl_Check_Button(int X, int Y, int W, int H, const char *l)
 : Fl_Light_Button(X, Y, W, H, l) {
diff --git a/src/Fl_Gl_Window.cxx b/src/Fl_Gl_Window.cxx
index 8d1a587be..5be36893c 100644
--- a/src/Fl_Gl_Window.cxx
+++ b/src/Fl_Gl_Window.cxx
@@ -79,18 +79,6 @@ static char SWAP_TYPE = 0 ; // 0 = determine it from environment variable
   Returns non-zero if the hardware supports the given or current OpenGL
   mode.
   
-  <h4>void* Fl_Gl_Window::context() const;
-  <br>void Fl_Gl_Window::context(void*, int destroy_flag = false);</h4>
-  
-  Return or set a pointer to the GLContext that this window is
-  using. This is a system-dependent structure, but it is portable to copy
-  the context from one window to another. You can also set it to NULL,
-  which will force FLTK to recreate the context the next time make_current() is called, this is
-  useful for getting around bugs in OpenGL implementations.
-  
-  <p>If <i>destroy_flag</i> is true the context will be destroyed by
-  fltk when the window is destroyed, or when the mode() is changed, or the next time
-  context(x) is called.
 */
 int Fl_Gl_Window::can_do(int a, const int *b) {
   return Fl_Gl_Choice::find(a,b) != 0;
@@ -444,6 +432,17 @@ void Fl_Gl_Window::resize(int X,int Y,int W,int H) {
   Fl_Window::resize(X,Y,W,H);
 }
 
+/**
+  Returns or sets a pointer to the GLContext that this window is
+  using. This is a system-dependent structure, but it is portable to copy
+  the context from one window to another. You can also set it to NULL,
+  which will force FLTK to recreate the context the next time make_current() is called, this is
+  useful for getting around bugs in OpenGL implementations.
+  
+  <p>If <i>destroy_flag</i> is true the context will be destroyed by
+  fltk when the window is destroyed, or when the mode() is changed, or the next time
+  context(x) is called.
+*/
 void Fl_Gl_Window::context(void* v, int destroy_flag) {
   if (context_ && !(mode_&NON_LOCAL_CONTEXT)) fl_delete_gl_context(context_);
   context_ = (GLContext)v;
diff --git a/src/Fl_Group.cxx b/src/Fl_Group.cxx
index 4879e5c2f..7fc0d4e88 100644
--- a/src/Fl_Group.cxx
+++ b/src/Fl_Group.cxx
@@ -87,7 +87,7 @@ void Fl_Group::current(Fl_Group *g) {current_ = g;}
 
 extern Fl_Widget* fl_oldfocus; // set by Fl::focus
 
-// For back-compatability, we must adjust all events sent to child
+// For back-compatibility, we must adjust all events sent to child
 // windows so they are relative to that window.
 
 static int send(Fl_Widget* o, int event) {
diff --git a/src/Fl_Menu.cxx b/src/Fl_Menu.cxx
index a7af493df..15fcee9aa 100644
--- a/src/Fl_Menu.cxx
+++ b/src/Fl_Menu.cxx
@@ -160,7 +160,7 @@ void Fl_Menu_Item::draw(int x, int y, int w, int h, const Fl_Menu_* m,
   if (selected) {
     Fl_Color r = m ? m->selection_color() : FL_SELECTION_COLOR;
     Fl_Boxtype b = m && m->down_box() ? m->down_box() : FL_FLAT_BOX;
-    if (fl_contrast(r,color)!=r) { // back compatability boxtypes
+    if (fl_contrast(r,color)!=r) { // back compatibility boxtypes
       if (selected == 2) { // menu title
 	r = color;
 	b = m ? m->box() : FL_UP_BOX;
diff --git a/src/Fl_Menu_Button.cxx b/src/Fl_Menu_Button.cxx
index 5474cbaaf..7d7402e4c 100644
--- a/src/Fl_Menu_Button.cxx
+++ b/src/Fl_Menu_Button.cxx
@@ -37,7 +37,7 @@ void Fl_Menu_Button::draw() {
   draw_box(pressed_menu_button_ == this ? fl_down(box()) : box(), color());
   draw_label();
   if (Fl::focus() == this) draw_focus();
-  if (box() == FL_FLAT_BOX) return; // for XForms compatability
+  if (box() == FL_FLAT_BOX) return; // for XForms compatibility
   int H = (labelsize()-3)&-2;
   int X = x()+w()-H*2;
   int Y = y()+(h()-H)/2;
diff --git a/src/Fl_Round_Button.cxx b/src/Fl_Round_Button.cxx
index d86611e0c..31168867f 100644
--- a/src/Fl_Round_Button.cxx
+++ b/src/Fl_Round_Button.cxx
@@ -27,7 +27,7 @@
 
 // A subclass of Fl_Button that always draws as a round circle.  This
 // circle is smaller than the widget size and can be surrounded by
-// another box type, for compatability with Forms.
+// another box type, for compatibility with Forms.
 
 #include <FL/Fl.H>
 #include <FL/Fl_Round_Button.H>
diff --git a/src/Fl_Widget.cxx b/src/Fl_Widget.cxx
index f96051a0e..3ebd25b86 100644
--- a/src/Fl_Widget.cxx
+++ b/src/Fl_Widget.cxx
@@ -35,9 +35,9 @@
 
 
 ////////////////////////////////////////////////////////////////
-// for compatability with Forms, all widgets without callbacks are
+// for compatibility with Forms, all widgets without callbacks are
 // inserted into a "queue" when they are activated, and the forms
-// compatability interaction functions (fl_do_events, etc) will
+// compatibility interaction functions (fl_do_events, etc) will
 // read one widget at a time from this queue and return it:
 
 const int QUEUE_SIZE = 20;
@@ -47,7 +47,7 @@ static int obj_head, obj_tail;
 
 void Fl_Widget::default_callback(Fl_Widget *o, void * /*v*/) {
 #if 0
-  // This is necessary for strict forms compatability but is confusing.
+  // This is necessary for strict forms compatibility but is confusing.
   // Use the parent's callback if this widget does not have one.
   for (Fl_Widget *p = o->parent(); p; p = p->parent())
     if (p->callback() != default_callback) {
diff --git a/src/Fl_Window.cxx b/src/Fl_Window.cxx
index c4a7ca8ce..c08b5bc5b 100644
--- a/src/Fl_Window.cxx
+++ b/src/Fl_Window.cxx
@@ -156,7 +156,7 @@ void Fl_Window::iconlabel(const char *iname) {
   set_flag(saveflags);
 }
 
-// the Fl::atclose pointer is provided for back compatability.  You
+// the Fl::atclose pointer is provided for back compatibility.  You
 // can now just change the callback for the window instead.
 
 /** Default callback for window widgets. It hides the window and then calls the default widget callback. */
diff --git a/src/Fl_x.cxx b/src/Fl_x.cxx
index c13ec9958..05f225e91 100644
--- a/src/Fl_x.cxx
+++ b/src/Fl_x.cxx
@@ -1166,7 +1166,7 @@ int fl_handle(const XEvent& thisevent)
       Fl::e_length = len;
     } else {
       // Stupid X sends fake key-up events when a repeating key is held
-      // down, probably due to some back compatability problem. Fortunately
+      // down, probably due to some back compatibility problem. Fortunately
       // we can detect this because the repeating KeyPress event is in
       // the queue, get it and execute it instead:
       XEvent temp;
diff --git a/src/fl_symbols.cxx b/src/fl_symbols.cxx
index e25fea615..f39a9093c 100644
--- a/src/fl_symbols.cxx
+++ b/src/fl_symbols.cxx
@@ -94,7 +94,7 @@ int fl_add_symbol(const char *name, void (*drawit)(Fl_Color), int scalable)
 
 int fl_return_arrow(int x,int y,int w,int h);
 
-// provided for back compatability:
+// provided for back compatibility:
 int fl_draw_symbol(const char *label,int x,int y,int w,int h,Fl_Color col) {  
   const char *p = label;
   if (*p++ != '@') return 0;
diff --git a/src/fl_utf.c b/src/fl_utf.c
index 33b7a2cfc..c3e80f7f2 100644
--- a/src/fl_utf.c
+++ b/src/fl_utf.c
@@ -612,7 +612,7 @@ unsigned fl_utf8froma(char* dst, unsigned dstlen,
     to a string containing the letters "utf" or "UTF" in it, or by
     deleting all $LC* and $LANG environment variables. In the future
     it is likely that all non-Asian Unix systems will return true,
-    due to the compatability of UTF-8 with ISO-8859-1.
+    due to the compatibility of UTF-8 with ISO-8859-1.
 */
 int fl_utf8locale(void) {
   static int ret = 2;
diff --git a/src/forms_compatability.cxx b/src/forms_compatability.cxx
index 0fe44bacd..e8cba24da 100644
--- a/src/forms_compatability.cxx
+++ b/src/forms_compatability.cxx
@@ -25,7 +25,7 @@
 //     http://www.fltk.org/str.php
 //
 
-// Forms library compatability functions.
+// Forms library compatibility functions.
 // Many more functions are defined as inlines in forms.h!
 
 #include <FL/forms.H>
@@ -140,7 +140,7 @@ void fl_set_graphics_mode(int /*r*/,int /*d*/) {}
 
 void Fl_FormsText::draw() {
   draw_box();
-  align(align()|FL_ALIGN_INSIDE); // questionable method of compatability
+  align(align()|FL_ALIGN_INSIDE); // questionable method of compatibility
   draw_label();
 }
 
diff --git a/src/forms_free.cxx b/src/forms_free.cxx
index 918086d79..ec5346299 100644
--- a/src/forms_free.cxx
+++ b/src/forms_free.cxx
@@ -59,7 +59,7 @@ void Fl_Free::step(void *v) {
     The event argument contains the event type:
     <UL>
     <PRE>
-    // old event names for compatability:
+    // old event names for compatibility:
     #define FL_MOUSE		FL_DRAG
     #define FL_DRAW			0
     #define FL_STEP			9