Moving more documentation into doxygen format

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

1 files changed, 20 insertions, 0 deletions

diff --git a/FL/Enumerations.H b/FL/Enumerations.H
index 2f7331fac..a50fb0131 100644
--- a/FL/Enumerations.H
+++ b/FL/Enumerations.H
@@ -472,16 +472,36 @@ extern Fl_Labeltype FL_EXPORT fl_define_FL_ENGRAVED_LABEL();
 extern Fl_Labeltype FL_EXPORT fl_define_FL_EMBOSSED_LABEL();
 #define FL_EMBOSSED_LABEL fl_define_FL_EMBOSSED_LABEL()
 
+/** Flags to control the label alignment. 
+ *  This controls how the label is displayed next to or inside the widget. 
+ *  The default value is FL_ALIGN_CENTER for most widgets, which centers the label
+ *  inside the widget.
+ *
+ *  Flags can be or'd to achieve a combination of alignments.
+ */
 enum Fl_Align {	// align() values
+  /** Align the label horizontally in the middle. */
   FL_ALIGN_CENTER		= 0,
+  /** Align the label at the top of the widget. Inside labels appear below the top,
+   *  outside labels are drawn on top of the widget. */
   FL_ALIGN_TOP			= 1,
+  /** Align the label at the bottom of the widget. */
   FL_ALIGN_BOTTOM		= 2,
+  /** Align the label at the left of the widget. Inside labels appear left-justified
+   *  starting at the left side of the widget, outside labels are right-justified and
+   *  drawn to the left of the widget. */
   FL_ALIGN_LEFT			= 4,
+  /** Align the label to the right of the widget. */
   FL_ALIGN_RIGHT		= 8,
+  /** Draw the label inside of the widget. */
   FL_ALIGN_INSIDE		= 16,
+  /** If the label contains an image, draw the text on top of the image. */
   FL_ALIGN_TEXT_OVER_IMAGE	= 32,
+  /** If the label contains an image, draw the text below the image. */
   FL_ALIGN_IMAGE_OVER_TEXT	= 0,
+  /** All parts of the label that are lager than the widget will not be drawn . */
   FL_ALIGN_CLIP			= 64,
+  /** Wrap text that does not fit the width of the widget. */
   FL_ALIGN_WRAP			= 128,
   FL_ALIGN_TOP_LEFT		= FL_ALIGN_TOP | FL_ALIGN_LEFT,
   FL_ALIGN_TOP_RIGHT		= FL_ALIGN_TOP | FL_ALIGN_RIGHT,