Doxygen Documentation WP4 Done. Has all documentation content but should be completed in increment 2. Registered for WP5.

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

1 files changed, 25 insertions, 0 deletions

diff --git a/FL/Fl_Pack.H b/FL/Fl_Pack.H
index ea59f7bf9..1e6e3007d 100644
--- a/FL/Fl_Pack.H
+++ b/FL/Fl_Pack.H
@@ -30,6 +30,22 @@
 
 #include <FL/Fl_Group.H>
 
+/**
+  This widget was designed to add the functionality of compressing and
+  aligning widgets.
+  <P>If type() is Fl_Pack::HORIZONTAL all the children are
+  resized to the height of the Fl_Pack, and are moved next to
+  each other horizontally. If type() is not Fl_Pack::HORIZONTAL
+  then the children are resized to the width and are stacked below each
+  other.  Then the Fl_Pack resizes itself to surround the child
+  widgets.
+  <P>This widget is needed for the Fl_Tabs.
+  In addition you may want to put the Fl_Pack inside an 
+  Fl_Scroll.
+
+  <P>The resizable for Fl_Pack is set to NULL by default.</p>
+  <P>See also: Fl_Group::resizable()
+*/
 class FL_EXPORT Fl_Pack : public Fl_Group {
   int spacing_;
 public:
@@ -39,8 +55,17 @@ public:
   };
   void draw();
   Fl_Pack(int x,int y,int w ,int h,const char *l = 0);
+  /**
+    Gets the number of extra pixels of blank space that are added
+    between the children.
+  */
   int spacing() const {return spacing_;}
+  /**
+    Sets the number of extra pixels of blank space that are added
+    between the children.
+  */
   void spacing(int i) {spacing_ = i;}
+  /** Same as Fl_Group::type() */
   uchar horizontal() const {return type();}
 };