[Gtk2hs-commit] gtk2hs/gtk/Graphics/UI/Gtk/Ornaments Frame.chs,1.2,1.3 HSeparator.chs,1.2,1.3 VSeparator.chs,1.2,1.3

[Duncan C. <dun...@us...>]

Update of /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Ornaments
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24163/gtk/Graphics/UI/Gtk/Ornaments

Modified Files:
	Frame.chs HSeparator.chs VSeparator.chs 
Log Message:
Add more module level documentation and tidy up exiting documentation.
Also add/modify section headers.
Also LGPL'ify remaining modules with permission from Matthew Walton.


Index: Frame.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Ornaments/Frame.chs,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- Frame.chs	12 Feb 2005 17:19:24 -0000	1.2
+++ Frame.chs	25 Feb 2005 01:11:36 -0000	1.3
@@ -28,10 +28,34 @@
 -- logically separate items in a dialog box.
 --
 module Graphics.UI.Gtk.Ornaments.Frame (
+-- * Description
+-- 
+-- | The frame widget is a Bin that surrounds its child with a decorative
+-- frame and an optional label. If present, the label is drawn in a gap in the
+-- top side of the frame. The position of the label can be controlled with
+-- 'frameSetLabelAlign'.
+
+-- * Class Hierarchy
+-- |
+-- @
+-- |  'GObject'
+-- |   +----'Object'
+-- |         +----'Widget'
+-- |               +----'Container'
+-- |                     +----'Bin'
+-- |                           +----Frame
+-- |                                 +----'AspectFrame'
+-- @
+
+-- * Types
   Frame,
   FrameClass,
   castToFrame,
+
+-- * Constructors
   frameNew,
+
+-- * Methods
   frameSetLabel,
   frameGetLabel,
   frameSetLabelWidget,
@@ -54,7 +78,8 @@
 
 {# context lib="gtk" prefix="gtk" #}
 
--- methods
+--------------------
+-- Constructors
 
 -- | Create a new frame without a label.
 --
@@ -64,6 +89,9 @@
 frameNew  = makeNewObject mkFrame $
   liftM castPtr $ {#call unsafe frame_new#} nullPtr
 
+--------------------
+-- Methods
+
 -- | Replace the label of the frame.
 --
 frameSetLabel :: FrameClass f => f -> String -> IO ()
@@ -128,5 +156,3 @@
   {#call unsafe g_free#} (castPtr strPtr)
   return res
 
-
-   

Index: HSeparator.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Ornaments/HSeparator.chs,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- HSeparator.chs	12 Feb 2005 17:19:24 -0000	1.2
+++ HSeparator.chs	25 Feb 2005 01:11:36 -0000	1.3
@@ -24,16 +24,31 @@
 -- Stability   : provisional
 -- Portability : portable (depends on GHC)
 --
--- The HSeparator widget is a horizontal separator, used to group the 
--- widgets within a window. It displays a horizontal line with a shadow 
--- to make it appear sunken into the interface.
---
--- * This has nothing to do with a menu separator.
+-- A horizontal separator.
 --
 module Graphics.UI.Gtk.Ornaments.HSeparator (
+-- * Description
+-- 
+-- | The 'HSeparator' widget is a horizontal separator, used to group the
+-- widgets within a window. It displays a horizontal line with a shadow to make
+-- it appear sunken into the interface.
+
+-- * Class Hierarchy
+-- |
+-- @
+-- |  'GObject'
+-- |   +----'Object'
+-- |         +----'Widget'
+-- |               +----'Separator'
+-- |                     +----HSeparator
+-- @
+
+-- * Types
   HSeparator,
   HSeparatorClass,
   castToHSeparator,
+
+-- * Constructors
   hSeparatorNew
   ) where
 
@@ -46,7 +61,8 @@
 
 {# context lib="gtk" prefix="gtk" #}
 
--- methods
+--------------------
+-- Constructors
 
 hSeparatorNew :: IO HSeparator
 hSeparatorNew = makeNewObject mkHSeparator $ 

Index: VSeparator.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/Graphics/UI/Gtk/Ornaments/VSeparator.chs,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- VSeparator.chs	12 Feb 2005 17:19:24 -0000	1.2
+++ VSeparator.chs	25 Feb 2005 01:11:36 -0000	1.3
@@ -24,16 +24,31 @@
 -- Stability   : provisional
 -- Portability : portable (depends on GHC)
 --
--- The VSeparator widget is a horizontal separator, used to group the 
--- widgets within a window. It displays a horizontal line with a shadow 
--- to make it appear sunken into the interface.
---
--- * This has nothing to do with a menu separator.
+-- A vertical separator.
 --
 module Graphics.UI.Gtk.Ornaments.VSeparator (
+-- * Description
+-- 
+-- | The 'VSeparator' widget is a vertical separator, used to group the
+-- widgets within a window. It displays a vertical line with a shadow to make
+-- it appear sunken into the interface.
+
+-- * Class Hierarchy
+-- |
+-- @
+-- |  'GObject'
+-- |   +----'Object'
+-- |         +----'Widget'
+-- |               +----'Separator'
+-- |                     +----VSeparator
+-- @
+
+-- * Types
   VSeparator,
   VSeparatorClass,
   castToVSeparator,
+
+-- * Constructors
   vSeparatorNew
   ) where
 
@@ -46,7 +61,8 @@
 
 {# context lib="gtk" prefix="gtk" #}
 
--- methods
+--------------------
+-- Constructors
 
 vSeparatorNew :: IO VSeparator
 vSeparatorNew = makeNewObject mkVSeparator $