Documentation updates (part of STR #2751).

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

1 files changed, 9 insertions, 7 deletions

diff --git a/FL/Fl_Input_.H b/FL/Fl_Input_.H
index 86a84f00a..99a396506 100644
--- a/FL/Fl_Input_.H
+++ b/FL/Fl_Input_.H
@@ -3,7 +3,7 @@
 //
 // Input base class header file for the Fast Light Tool Kit (FLTK).
 //
-// Copyright 1998-2011 by Bill Spitzak and others.
+// Copyright 1998-2015 by Bill Spitzak and others.
 //
 // This library is free software. Distribution and use rights are outlined in
 // the file "COPYING" which should have been included with this file.  If this
@@ -102,14 +102,14 @@ class FL_EXPORT Fl_Input_ : public Fl_Widget {
   /** \internal Size of text in bytes in the \p value_ field. */
   int size_;
 
-  /** \internal \todo Please document me! */
+  /** \internal Current size of internal value() buffer in bytes. */
   int bufsize;
-  
+
   /** \internal Position of the cursor in the document. */
   int position_;
 
-  /** \internal Position of the other end of the selected text. If \p position_ equals 
-      \p mark_, no text is selected */
+  /** \internal Position of the other end of the selected text.
+      If \p position_ equals \p mark_, no text is selected */
   int mark_;
 
   /** \internal Behavior of Tab key in multiline input widget. 
@@ -124,7 +124,7 @@ class FL_EXPORT Fl_Input_ : public Fl_Widget {
       of the buffer. */
   int mu_p;
 
-  /** \internal Maximum number of characters. */
+  /** \internal Maximum number of (UTF-8) characters a user can input. */
   int maximum_size_;
 
   /** \internal Shortcut key that will fetch focus for this widget. */
@@ -266,9 +266,11 @@ public:
   int maximum_size() const {return maximum_size_;}
 
   /** Sets the maximum length of the input field in characters.
+
     This limits the number of <b>characters</b> that can be inserted
     in the widget.
-    \since FLTK 1.3 this is different than the buffer size, since one
+
+    Since FLTK 1.3 this is different than the buffer size, since one
     character can be more than one byte in UTF-8 encoding. In FLTK 1.1
     this was the same (one byte = one character).
   */