From acef469350ac523e7df6fe9f520a9b1ac9e86642 Mon Sep 17 00:00:00 2001
From: engelsman <engelsman>
Date: Mon, 16 Mar 2009 22:38:32 +0000
Subject: doxygen comments for fl_box(), fl_down(), fl_frame() and converted
 html tags

FL/Enumerations.H: doxygen comments for fl_box(), fl_down(), fl_frame()
documentation/src/common.dox: converted html tags to doxyge commands
documentation/src/preface.dox: corrected footer link
documentation/src/index.dox: corrected footer link



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6694 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 FL/Enumerations.H | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'FL')

diff --git a/FL/Enumerations.H b/FL/Enumerations.H
index 7faa77b37..7059d6d85 100644
--- a/FL/Enumerations.H
+++ b/FL/Enumerations.H
@@ -529,12 +529,27 @@ extern FL_EXPORT Fl_Boxtype fl_define_FL_GTK_UP_BOX();
 #define FL_GTK_ROUND_DOWN_BOX (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+9)
 
 // conversions of box types to other boxtypes:
+/**
+  Get the filled version of a frame.
+  If no filled version of a given frame exists, the behavior of this function
+  is undefined and some random box or frame is returned,
+  */
 inline Fl_Boxtype fl_box(Fl_Boxtype b) {
   return (Fl_Boxtype)((b<FL_UP_BOX||b%4>1)?b:(b-2));
 }
+/**
+  Get the "pressed" or "down" version of a box.
+  If no "down" version of a given box exists, the behavior of this function
+  is undefined and some random box or frame is returned,
+  */
 inline Fl_Boxtype fl_down(Fl_Boxtype b) {
   return (Fl_Boxtype)((b<FL_UP_BOX)?b:(b|1));
 }
+/**
+  Get the unfilled, frame only version of a box.
+  If no frame version of a given box exists, the behavior of this function
+  is undefined and some random box or frame is returned,
+  */
 inline Fl_Boxtype fl_frame(Fl_Boxtype b) {
   return (Fl_Boxtype)((b%4<2)?b:(b+2));
 }
-- 
cgit v1.2.3