Non-changing changes... Attempting to keep the porting branch somehwat in-sync with doc changes in main 1.3.x

None of these changes alter the actual code.



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

1 files changed, 16 insertions, 7 deletions

diff --git a/FL/Fl_Text_Display.H b/FL/Fl_Text_Display.H
index f1ae90ed8..7237bc86f 100644
--- a/FL/Fl_Text_Display.H
+++ b/FL/Fl_Text_Display.H
@@ -3,7 +3,7 @@
 //
 // Header file for Fl_Text_Display class.
 //
-// Copyright 2001-2010 by Bill Spitzak and others.
+// Copyright 2001-2016 by Bill Spitzak and others.
 // Original code Copyright Mark Edel.  Permission to distribute under
 // the LGPL for the FLTK library granted by Mark Edel.
 //
@@ -133,14 +133,23 @@ public:
   typedef void (*Unfinished_Style_Cb)(int, void *);
   
   /** 
-   This structure associates the color, font, andsize of a string to draw
-   with an attribute mask matching attr
+   This structure associates the color, font, and font size of a string to draw
+   with an attribute mask matching attr.
+
+   There must be one entry for each style that can be used in an
+   Fl_Text_Display for displaying text. The style table is an array of
+   struct Style_Table_Entry.
+
+   The style table is associated with an Fl_Text_Display by using
+   Fl_Text_Display::highlight_data().
+   
+   \see Fl_Text_Display::highlight_data()
    */
   struct Style_Table_Entry {
-    Fl_Color    color;
-    Fl_Font     font;
-    Fl_Fontsize size;
-    unsigned    attr;
+    Fl_Color    color;	///< text color
+    Fl_Font     font;	///< text font
+    Fl_Fontsize size;	///< text font size
+    unsigned    attr;	///< currently unused (this may be change in the future)
   };
   
   Fl_Text_Display(int X, int Y, int W, int H, const char *l = 0);