Documentation fixes and a few indent corrections.

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

3 files changed, 29 insertions, 31 deletions

diff --git a/src/Fl_Paged_Device.cxx b/src/Fl_Paged_Device.cxx
index ae7f7d832..d5f3ff8b7 100644
--- a/src/Fl_Paged_Device.cxx
+++ b/src/Fl_Paged_Device.cxx
@@ -3,7 +3,7 @@
 //
 // implementation of Fl_Paged_Device class for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 2010 by Bill Spitzak and others.
+// Copyright 2010-2011 by Bill Spitzak and others.
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Library General Public
@@ -74,7 +74,7 @@ void Fl_Paged_Device::print_widget(Fl_Widget* widget, int delta_x, int delta_y)
       int width, height;
       this->printable_rect(&width, &height);
       drawn_by_plugin = pi->print(widget, 0, 0, height);
-      }
+    }
   }
   if (!drawn_by_plugin) {
     widget->draw();
@@ -118,7 +118,7 @@ void Fl_Paged_Device::origin(int *x, int *y)
 
 /**
  @brief Prints a rectangular part of an on-screen window.
- *
+
  @param win The window from where to capture.
  @param x The rectangle left
  @param y The rectangle top
@@ -150,7 +150,7 @@ void Fl_Paged_Device::print_window_part(Fl_Window *win, int x, int y, int w, int
 
 /**
  @brief Starts a print job.
- *
+
  @param[in] pagecount the total number of pages of the job
  @param[out] frompage if non-null, *frompage is set to the first page the user wants printed
  @param[out] topage if non-null, *topage is set to the last page the user wants printed
@@ -160,7 +160,7 @@ int Fl_Paged_Device::start_job(int pagecount, int *frompage, int *topage) {retur
 
 /**
  @brief Starts a new printed page
- *
+
  The page coordinates are initially in points, i.e., 1/72 inch, 
  and with origin at the top left of the printable page area.
  @return 0 if OK, non-zero if any error
@@ -169,7 +169,7 @@ int Fl_Paged_Device::start_page (void) {return 1;}
 
 /**
  @brief Computes the width and height of the printable area of the page.
- *
+
  Values are in the same unit as that used by FLTK drawing functions,
  are unchanged by calls to origin(), but are changed by scale() calls.
  Values account for the user-selected paper type and print orientation.
@@ -180,7 +180,7 @@ int Fl_Paged_Device::printable_rect(int *w, int *h) {return 1;}
 /**
  @brief Computes the dimensions of margins that lie between the printable page area and
  the full page.
- *
+
  Values are in the same unit as that used by FLTK drawing functions. They are changed
  by scale() calls.
  @param[out] left If non-null, *left is set to the left margin size.
@@ -192,7 +192,7 @@ void Fl_Paged_Device::margins(int *left, int *top, int *right, int *bottom) {}
 
 /**
  @brief Sets the position in page coordinates of the origin of graphics functions.
- *
+
  Arguments should be expressed relatively to the result of a previous printable_rect() call.
  That is, <tt>printable_rect(&w, &h); origin(w/2, 0);</tt> sets the graphics origin at the
  top center of the page printable area.
@@ -205,7 +205,7 @@ void Fl_Paged_Device::origin(int x, int y) {}
 
 /**
  @brief Changes the scaling of page coordinates.
- *
+
  This function also resets the origin of graphics functions at top left of printable page area.
  After a scale() call, do a printable_rect() call to get the new dimensions of the printable page area.
  Successive scale() calls don't combine their effects.
@@ -218,16 +218,16 @@ void Fl_Paged_Device::scale (float scale_x, float scale_y) {}
 
 /**
  @brief Rotates the graphics operations relatively to paper.
- *
+
  The rotation is centered on the current graphics origin. 
  Successive rotate() calls don't combine their effects.
- @param angle Rotation angle in counterclockwise degrees.
+ @param angle Rotation angle in counter-clockwise degrees.
  */
 void Fl_Paged_Device::rotate(float angle) {}
 
 /**
  @brief To be called at the end of each page.
- *
+
  @return 0 if OK, non-zero if any error.
  */
 int Fl_Paged_Device::end_page (void) {return 1;}
@@ -239,7 +239,7 @@ void Fl_Paged_Device::end_job (void) {}
 
 /**
  @brief Translates the current graphics origin accounting for the current rotation.
- *
+
  This function is only useful after a rotate() call. 
  Each translate() call must be matched by an untranslate() call.
  Successive translate() calls add up their effects.
@@ -295,4 +295,3 @@ const Fl_Paged_Device::page_format Fl_Paged_Device::page_formats[NO_PAGE_FORMATS
 //
 // End of "$Id$".
 //
-
diff --git a/src/fl_shortcut.cxx b/src/fl_shortcut.cxx
index 2305545f6..105ad5995 100644
--- a/src/fl_shortcut.cxx
+++ b/src/fl_shortcut.cxx
@@ -3,7 +3,7 @@
 //
 // Shortcut support routines for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2010 by Bill Spitzak and others.
+// Copyright 1998-2011 by Bill Spitzak and others.
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Library General Public
@@ -34,7 +34,7 @@
 // To make it easier to match some things it is more complex:
 //
 // Only FL_META, FL_ALT, FL_SHIFT, and FL_CTRL must be "off".  A
-// zero in the other shift flags indicates "dont care".
+// zero in the other shift flags indicates "don't care".
 //
 // It also checks against the first character of Fl::event_text(),
 // and zero for FL_SHIFT means "don't care".
@@ -52,13 +52,12 @@
 #endif
 
 /**
-    Test the current event, which must be an FL_KEYBOARD or 
-    FL_SHORTCUT, against a shortcut value (described in 
-    Fl_Button).
-    
-    Not to be confused with Fl_Widget::test_shortcut().
-    
-    \return non-zero if there is a match.
+  Tests the current event, which must be an FL_KEYBOARD or
+  FL_SHORTCUT, against a shortcut value (described in Fl_Button).
+
+  Not to be confused with Fl_Widget::test_shortcut().
+
+  \return non-zero if there is a match.
 */
 int Fl::test_shortcut(unsigned int shortcut) {
   if (!shortcut) return 0;
@@ -129,7 +128,7 @@ static Keyname table[] = {
 };
 #elif defined(__APPLE__) 
 static Keyname table[] = {
-                                 // v - this column contains utf8 characters
+                                 // v - this column contains UTF-8 characters
   {' ', "Space"},
   {FL_BackSpace,"\xe2\x8c\xab"}, // erase to the left
   {FL_Tab,	"\xe2\x87\xa5"}, // rightwards arrow to bar
@@ -144,7 +143,7 @@ static Keyname table[] = {
   {FL_Right,	"\xe2\x86\x92"}, // rightwards arrow
   {FL_Down,	"\xe2\x86\x93"}, // downwards arrow
   {FL_Page_Up,	"\xe2\x87\x9e"}, // upwards arrow with double stroke
-  {FL_Page_Down,"\xe2\x87\x9f"}, // downward arrow with double stroke
+  {FL_Page_Down,"\xe2\x87\x9f"}, // downwards arrow with double stroke
   {FL_End,	"\xe2\x86\x98"}, // south east arrow
   {FL_Print,	"Print"},
   {FL_Insert,	"Insert"},
@@ -173,7 +172,7 @@ static Keyname table[] = {
   zero then an empty string is returned. The return value points at
   a static buffer that is overwritten with each call.
 
-  \param [in] shortcut the integer value containing the ascii charcter or extended keystroke plus modifiers
+  \param [in] shortcut the integer value containing the ascii character or extended keystroke plus modifiers
   \return a pointer to a static buffer containing human readable text for the shortcut
   */
 const char* fl_shortcut_label(unsigned int shortcut) {
@@ -183,7 +182,7 @@ const char* fl_shortcut_label(unsigned int shortcut) {
 /** 
   Get a human-readable string from a shortcut value.
 
-  \param [in] shortcut the integer value containing the ascii charcter or extended keystroke plus modifiers
+  \param [in] shortcut the integer value containing the ascii character or extended keystroke plus modifiers
   \param [in] eom if this pointer is set, it will receive a pointer to the end of the modifier text
   \return a pointer to a static buffer containing human readable text for the shortcut
   \see fl_shortcut_label(unsigned int shortcut)
@@ -298,7 +297,7 @@ unsigned int fl_old_shortcut(const char* s) {
 
   The given text \p t (usually a widget's label or a menu text) is
   searched for a '&x' shortcut label, and if found, the Unicode
-  value of the '&x' shortcut is returned.
+  value (code point) of the '&x' shortcut is returned.
 
   \param t text or label to search for '&x' shortcut.
 
diff --git a/src/fl_vertex.cxx b/src/fl_vertex.cxx
index c63c8c54a..506268b7a 100644
--- a/src/fl_vertex.cxx
+++ b/src/fl_vertex.cxx
@@ -3,7 +3,7 @@
 //
 // Portable drawing routines for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2010 by Bill Spitzak and others.
+// Copyright 1998-2011 by Bill Spitzak and others.
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Library General Public
@@ -270,8 +270,8 @@ void Fl_Graphics_Driver::circle(double x, double y,double r) {
   } else
     Arc(fl_gc, llx, lly, llx+w, lly+h, 0,0, 0,0); 
 #elif defined(__APPLE_QUARTZ__)
-  // Quartz warning : circle won't scale to current matrix!
-//last argument must be 0 (counterclockwise) or it draws nothing under __LP64__ !!!!
+  // Quartz warning: circle won't scale to current matrix!
+  // Last argument must be 0 (counter-clockwise) or it draws nothing under __LP64__ !!!!
   CGContextSetShouldAntialias(fl_gc, true);
   CGContextAddArc(fl_gc, xt, yt, (w+h)*0.25f, 0, 2.0f*M_PI, 0);
   (what == POLYGON ? CGContextFillPath : CGContextStrokePath)(fl_gc);