gtk2hs-commit — Mailing list for Darcs commit messages.

[Gtk2hs-commit] gtk2hs/gtk/glib GParameter.hsc,1.1,1.2

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

Update of /cvsroot/gtk2hs/gtk2hs/gtk/glib
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29916/gtk/glib

Modified Files:
	GParameter.hsc 
Log Message:
initial haddockification
(oops nearly missed this one)


Index: GParameter.hsc
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/glib/GParameter.hsc,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- GParameter.hsc	7 May 2004 16:40:00 -0000	1.1
+++ GParameter.hsc	23 May 2004 17:06:24 -0000	1.2
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry GParameter@
+--  GIMP Toolkit (GTK) GParameter
 --
 --  Author : Duncan Coutts
 --          
@@ -19,7 +19,7 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
+-- |
 --
 -- Storable instance for GParameter, used by objectNew
 --

[Gtk2hs-commit] gtk2hs/gtk/embedding Embedding.hsc,1.2,1.3 Plug.chs,1.3,1.4 Socket.chs,1.6,1.7

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

Update of /cvsroot/gtk2hs/gtk2hs/gtk/embedding
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29497/gtk/embedding

Modified Files:
	Embedding.hsc Plug.chs Socket.chs 
Log Message:
initial haddockification


Index: Embedding.hsc
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/embedding/Embedding.hsc,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- Embedding.hsc	9 Jul 2003 22:42:43 -0000	1.2
+++ Embedding.hsc	23 May 2004 17:04:07 -0000	1.3
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget Socket@
+--  GIMP Toolkit (GTK) Widget Socket
 --
 --  Author : Axel Simon
 --          
@@ -19,13 +19,9 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
---
--- @documentation@ ------------------------------------------------------------
---
+-- |
 --
--- @todo@ ---------------------------------------------------------------------
+-- TODO
 --
 -- * NativeWindowId is a CUInt for c2hs and a Word32 for hsc2hs. I used
 --   fromIntegral to make it work, but it doesn't feel right.
@@ -42,11 +38,11 @@
 
 #include<gtk/gtk.h>
 
--- @type NativeWindowId@ The identifer of a window to be embedded.
+-- | The identifer of a window to be embedded.
 --
 type NativeWindowId = #type GdkNativeWindow
 
--- @method socketHasPlug@ Test if a Plug is connected to the socket.
+-- | Test if a Plug is connected to the socket.
 -- 
 socketHasPlug :: SocketClass s => s -> IO Bool
 socketHasPlug socket = do

Index: Plug.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/embedding/Plug.chs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- Plug.chs	9 Jul 2003 22:42:43 -0000	1.3
+++ Plug.chs	23 May 2004 17:04:07 -0000	1.4
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget Plug@
+--  GIMP Toolkit (GTK) Widget Plug
 --
 --  Author : Axel Simon
 --          
@@ -19,17 +19,13 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * Plug is a window that is to be attached to the window of another
---   application. If you have managed to receive the @ref type XID@ from
---   the inviting application you can construct the Plug and add your widgets
---   to it.
---
--- @documentation@ ------------------------------------------------------------
+-- |
 --
+-- Plug is a window that is to be attached to the window of another
+-- application. If you have managed to receive the 'XID' from
+-- the inviting application you can construct the Plug and add your widgets
+-- to it.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module Plug(
   Plug,
@@ -53,28 +49,28 @@
 
 -- methods
 
--- @constructor plugNew@ Create a new @ref data Window@ to hold another
+-- | Create a new 'Window' to hold another
 -- application.
 --
--- * The Plug may be constructed with a @ref data NativeWindowId@. In this
---   the foreign application will immediatly appear in this @ref data Plug@
---   once it is shown. If @literal Nothing@ is passed for @ref arg nmw@ a
---   @ref data NativeWindowId@ can be extracted from this @ref data Plug@
+-- * The Plug may be constructed with a 'NativeWindowId'. In this
+--   the foreign application will immediatly appear in this 'Plug'
+--   once it is shown. If @Nothing@ is passed for @nmw@ a
+--   'NativeWindowId' can be extracted from this 'Plug'
 --   and be passed to the application which is to be embedded.
 --
 plugNew :: Maybe NativeWindowId -> IO Plug
 plugNew mnw = makeNewObject mkPlug $ liftM castPtr $
   {#call unsafe plug_new#} (fromIntegral (fromMaybe 0 mnw))
 
--- @method plugGetId@ Retrieve the @ref data NativeWindowId@.
+-- | Retrieve the 'NativeWindowId'.
 --
 -- * The result should be passed to the application which is to be embedded.
---   See @ref constructor plugNew@.
+--   See 'plugNew'.
 --
 plugGetId :: PlugClass p => p -> IO NativeWindowId
 plugGetId p = liftM fromIntegral $ {#call unsafe plug_get_id#} (toPlug p)
 
--- @signal connectToEmbedded@ This plug received another application.
+-- | This plug received another application.
 --
 onEmbedded, afterEmbedded :: PlugClass p => p -> IO () -> IO (ConnectId p)
 onEmbedded = connect_NONE__NONE "embedded" False

Index: Socket.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/embedding/Socket.chs,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- Socket.chs	9 Jul 2003 22:42:43 -0000	1.6
+++ Socket.chs	23 May 2004 17:04:07 -0000	1.7
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget Socket@
+--  GIMP Toolkit (GTK) Widget Socket
 --
 --  Author : Axel Simon
 --          
@@ -19,26 +19,23 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * This widget provides the possibility that other application display their
---   widgets within this application.
+-- |
 --
--- @documentation@ ------------------------------------------------------------
+-- This widget provides the possibility that other application display their
+-- widgets within this application.
 --
 -- * After creation of the Socket, you may retrieve the 
---   @ref data NativeWindow@ of the socket. 
+--   'NativeWindow' of the socket. 
 --   For this to work, the socket must at least be realized (e.g. shown).
 --
--- * The application has to make sure the @ref data Socket@
+-- * The application has to make sure the 'Socket'
 --   is not destroyed while the
---   other application tries to connect. If the @ref data NativeWindow@ was 
+--   other application tries to connect. If the 'NativeWindow' was 
 --   transmitted, the
---   inviting application can check with @ref method socketHasPlug@ if the 
+--   inviting application can check with 'socketHasPlug' if the 
 --   plug has
 --   already connected.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module Socket(
   Socket,
@@ -67,44 +64,44 @@
 
 -- methods
 
--- @constructor socketNew@ Create a @ref data Container@ for embedding.
+-- | Create a 'Container' for embedding.
 --
--- * @ref data Socket@ is a @ref data Container@ for foreign applications
+-- * 'Socket' is a 'Container' for foreign applications
 --   that support the XEMBED protocol. To connect two applications the
---   @ref data NativeWindowId@ has to be passed either from this socket
---   to the other application's @ref data Plug@ or vice versa.
+--   'NativeWindowId' has to be passed either from this socket
+--   to the other application's 'Plug' or vice versa.
 --
 socketNew :: IO Socket
 socketNew = makeNewObject mkSocket $ liftM castPtr {#call unsafe socket_new#}
 
--- @method socketAddId@ Insert another application into this socket.
+-- | Insert another application into this socket.
 --
 -- * Inserts the other application into this plug. The
---   @ref data NativeWindowId@ comes from the other application.
+--   'NativeWindowId' comes from the other application.
 --
--- * The @ref data Socket@ must have already be added into a toplevel
+-- * The 'Socket' must have already be added into a toplevel
 --   window before you can make this call.
 --
 socketAddId :: SocketClass s => s -> NativeWindowId -> IO ()
 socketAddId soc nwi = {#call unsafe socket_add_id#} (toSocket soc) 
 		      (fromIntegral nwi)
 
--- @method socketGetId@ Prepare to insert this application into another.
+-- | Prepare to insert this application into another.
 --
--- * The extracted @ref data NativeWindowId@ can be passed to another
---   application which can then embed this socket @ref data Container@.
+-- * The extracted 'NativeWindowId' can be passed to another
+--   application which can then embed this socket 'Container'.
 --
 socketGetId :: SocketClass s => s -> IO NativeWindowId
 socketGetId soc = liftM fromIntegral $
 		  {#call unsafe socket_get_id#} (toSocket soc)
 
--- @signal connectToPlugAdded@ This socket was added into another application.
+-- | This socket was added into another application.
 --
 onPlugAdded, afterPlugAdded :: SocketClass s => s -> IO () -> IO (ConnectId s)
 onPlugAdded = connect_NONE__NONE "plug-added" False
 afterPlugAdded = connect_NONE__NONE "plug-added" True
 
--- @signal connectToPlugRemoved@ This socket was removed from another
+-- | This socket was removed from another
 -- application.
 --
 onPlugRemoved, afterPlugRemoved :: SocketClass s => s -> IO () -> 

[Gtk2hs-commit] gtk2hs ChangeLog,1.169,1.170

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29497

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.169
retrieving revision 1.170
diff -u -d -r1.169 -r1.170
--- ChangeLog	23 May 2004 16:17:53 -0000	1.169
+++ ChangeLog	23 May 2004 17:04:06 -0000	1.170
@@ -90,6 +90,9 @@
 	gtk/windows/FileSel.chs, gtk/windows/Window.chs:
 	initial haddockification
 
+	* embedding/Embedding.hsc, embedding/Plug.hs,
+	embedding/Socket.chs: initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs/gtk/windows Dialog.chs,1.5,1.6 FileChooserDialog.chs,1.2,1.3 FileSel.chs,1.6,1.7 Window.chs,1.6,1.7

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

Update of /cvsroot/gtk2hs/gtk2hs/gtk/windows
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv19222/gtk/windows

Modified Files:
	Dialog.chs FileChooserDialog.chs FileSel.chs Window.chs 
Log Message:
initial haddockification


Index: Dialog.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/windows/Dialog.chs,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- Dialog.chs	9 Jul 2003 22:42:46 -0000	1.5
+++ Dialog.chs	23 May 2004 16:17:53 -0000	1.6
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget Dialog@
+--  GIMP Toolkit (GTK) Widget Dialog
 --
 --  Author : Axel Simon
 --          
@@ -19,14 +19,10 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * A dialog is a smaller window that is used to ask the user for input.
---
--- @documentation@ ------------------------------------------------------------
+-- |
 --
+-- A dialog is a smaller window that is used to ask the user for input.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module Dialog(
   Dialog,
@@ -60,26 +56,26 @@
 
 -- methods
 
--- @constructor dialogNew@ Create a new Dialog.
+-- | Create a new Dialog.
 --
 dialogNew :: IO Dialog
 dialogNew  = makeNewObject mkDialog $ liftM castPtr {#call unsafe dialog_new#}
 
--- @method dialogRun@ Run the dialog by entering a new main loop.
+-- | Run the dialog by entering a new main loop.
 --
 -- * The dialog is run until it is either forced to quit (-1 will be returned)
 --   or until the user clicks a button (or other widget) in the action area
---   that makes the dialog emit the @ref arg response@ signal (the response id
+--   that makes the dialog emit the @response@ signal (the response id
 --   of the pressed button will be returned).
 --
--- * To force a dialog to quit, call @ref method dialogResponse@ on it.
+-- * To force a dialog to quit, call 'dialogResponse' on it.
 --
 -- * If this function returns the dialog still needs to be destroyed.
 --
 dialogRun :: DialogClass dc => dc -> IO ResponseId
 dialogRun dc = liftM toResponse $ {#call dialog_run#} (toDialog dc)
 
--- @method dialogResponse@ Emit the @ref arg response@ signal on the dialog.
+-- | Emit the @response@ signal on the dialog.
 --
 -- * This function can be used to add a custom widget to the action area that
 --   should close the dialog when activated or to close the dialog otherwise.
@@ -88,7 +84,7 @@
 dialogResponse dc resId = 
   {#call dialog_response#} (toDialog dc) (fromResponse resId)
 
--- @method dialogAddButton@ Add a button with a label to the action area.
+-- | Add a button with a label to the action area.
 --
 -- * The text may as well refer to a stock object. If such an object exists it
 --   is taken as widget.
@@ -100,9 +96,9 @@
   makeNewObject mkButton $ liftM castPtr $ {#call dialog_add_button#} 
   (toDialog dc) strPtr (fromResponse resId)
 
--- @method dialogAddActionWidget@ Add a widget to the action area. If the
--- widget is put into the activated state @ref arg resId@ will be transmitted
--- by the @ref arg response@ signal.
+-- | Add a widget to the action area. If the
+-- widget is put into the activated state @resId@ will be transmitted
+-- by the @response@ signal.
 --
 -- * A widget that cannot be activated and therefore has to emit the response
 --   signal manually must be added by packing it into the action area.
@@ -112,14 +108,14 @@
 dialogAddActionWidget dc child resId = {#call dialog_add_action_widget#}
   (toDialog dc) (toWidget child) (fromResponse resId)
 
--- @method dialogGetHasSeparator@ Query if the dialog has a visible horizontal
+-- | Query if the dialog has a visible horizontal
 -- separator.
 --
 dialogGetHasSeparator :: DialogClass dc => dc -> IO Bool
 dialogGetHasSeparator dc = liftM toBool $ 
   {#call unsafe dialog_get_has_separator#} (toDialog dc)
 
--- @method dialogSetDefaultResponse@ Set the default widget that is to be
+-- | Set the default widget that is to be
 -- activated if the user pressed enter. The object is specified by the
 -- ResponseId.
 --
@@ -127,14 +123,14 @@
 dialogSetDefaultResponse dc resId = {#call dialog_set_default_response#}
   (toDialog dc) (fromResponse resId)
 
--- @method dialogSetHasSeparator@ Set the visibility of the horizontal
+-- | Set the visibility of the horizontal
 -- separator.
 --
 dialogSetHasSeparator :: DialogClass dc => dc -> Bool -> IO ()
 dialogSetHasSeparator dc set = {#call dialog_set_has_separator#}
   (toDialog dc) (fromBool set)
 
--- @method dialogSetResponseSensitive@ Set widgets in the action are to be
+-- | Set widgets in the action are to be
 -- sensitive or not.
 --
 dialogSetResponseSensitive :: DialogClass dc => dc -> ResponseId -> Bool ->
@@ -145,7 +141,7 @@
 
 -- signals
 
--- @signal connectToResponse@ This signal is sent when a widget in the action
+-- | This signal is sent when a widget in the action
 -- area was activated, the dialog is received a destory event or the user
 -- calls dialogResponse. It is usually used to terminate the dialog (by
 -- dialogRun for example).

Index: FileChooserDialog.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/windows/FileChooserDialog.chs,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- FileChooserDialog.chs	7 May 2004 16:44:26 -0000	1.2
+++ FileChooserDialog.chs	23 May 2004 16:17:53 -0000	1.3
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
--- |GIMP Toolkit (GTK) @entry Widget FileChooserDialog@
+--  GIMP Toolkit (GTK) entry Widget FileChooserDialog
 --
 --  Author : Duncan Coutts
 --  Created: 24 April 2004
@@ -16,15 +16,15 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 --  Library General Public License for more details.
 --
---- Description ---------------------------------------------------------------
+-- |
 --
---  Language: Haskell 98 Binding Module
+-- The file chooser dialog and widget is a replacement
+-- for the old "FileSel"ection dialog. It provides a better user
+-- interface and an improved API.
 --
---  The file chooser dialog & widget is a replacement (introduced with gtk+ 2.4)
---  for the old and ugly GtkFileSelection dialog. It provides a better user
---  interface and an improved API
+-- * This is the dialog variant of the "FileChooser"
 --
---  This is the dialog variant of the FileChooser
+-- * Added in GTK+ 2.4
 --
 
 module FileChooserDialog (
@@ -75,7 +75,7 @@
 
 -- Annoyingly, the constructor for FileChooserDialog uses varargs so we can't
 -- call it using the Haskell FFI. The GTK people do not consider this an api
--- bug, see http://bugzilla.gnome.org/show_bug.cgi?id=141004
+-- bug, see <http://bugzilla.gnome.org/show_bug.cgi?id=141004>
 -- The solution is to call objectNew and add the buttons manually.
 
 internalFileChooserDialogNew :: Maybe String ->           -- Title of the dialog (or default)

Index: FileSel.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/windows/FileSel.chs,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- FileSel.chs	21 May 2004 14:00:33 -0000	1.6
+++ FileSel.chs	23 May 2004 16:17:53 -0000	1.7
@@ -1,5 +1,5 @@
 --  -*-haskell-*-
---  GIMP Toolkit (GTK) Binding for Haskell: @entry Widget FileSel@
+--  GIMP Toolkit (GTK) Binding for Haskell: Widget FileSel
 --
 --  Author : Manuel M T Chakravarty
 --  Created: 20 January 1999
@@ -19,19 +19,17 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 --  Library General Public License for more details.
 --
---- DESCRIPTION ---------------------------------------------------------------
---
---  The file selection widget is a quick and simple way to display a File
---  dialog box.  It comes complete with Ok & Cancel buttons; optionally, it
---  can have file operation buttons.
+-- |
 --
---- DOCU ----------------------------------------------------------------------
+-- The file selection widget is a quick and simple way to display a File
+-- dialog box.  It comes complete with Ok & Cancel buttons; optionally, it
+-- can have file operation buttons.
 --
---  As of gtk 2.4 this module has been deprecated in favour of FileChooser
+-- * As of gtk 2.4 this module has been deprecated in favour of "FileChooser"
 --
---- TODO ----------------------------------------------------------------------
+-- TODO
 --
---  Fix fileSelectionQueryButtons
+-- * Fix fileSelectionQueryButtons
 --
 module FileSel(
   FileSelectionClass,
@@ -58,7 +56,7 @@
 -- operations
 -- ----------
 
--- @constructor fileSelectionNew@ Create a new file selection dialog with 
+-- | Create a new file selection dialog with 
 -- the given window title.
 --
 fileSelectionNew       :: String -> IO FileSelection
@@ -67,7 +65,7 @@
     makeNewObject mkFileSelection $ liftM castPtr $ 
 			{#call unsafe file_selection_new#} strPtr
 
--- @method fileSelectionSetFilename@ Set the filename for the given file 
+-- | Set the filename for the given file 
 -- selection dialog.
 --
 fileSelectionSetFilename :: FileSelectionClass fsel => fsel -> String -> IO ()
@@ -75,7 +73,7 @@
   withUTFString str $ \strPtr -> 
     {#call unsafe file_selection_set_filename#} (toFileSelection fsel) strPtr
 
--- @method fileSelectionGetFilename@ Get the filename currently selected by 
+-- | Get the filename currently selected by 
 -- the given file selection dialog.
 --
 fileSelectionGetFilename :: FileSelectionClass fsel => fsel -> IO String
@@ -85,14 +83,14 @@
       (toFileSelection fsel)
     peekUTFString strPtr
 
--- @method fileSelectionShowFileopButtons@ Show the file operation buttons 
+-- | Show the file operation buttons 
 -- of the given file selection dialog.
 --
 fileSelectionShowFileopButtons :: FileSelectionClass fsel => fsel -> IO ()
 fileSelectionShowFileopButtons  =
   {#call file_selection_show_fileop_buttons#} . toFileSelection
 
--- @method fileSelectionHideFileopButtons@ Hide the file operation buttons 
+-- | Hide the file operation buttons 
 -- of the given file selection dialog.
 --
 fileSelectionHideFileopButtons :: FileSelectionClass fsel => fsel -> IO ()
@@ -115,7 +113,7 @@
 --       cancel <- {#get FileSelection.cancel_button#} ptr
 --       return (castToButton ok, castToButton cancel)
 
--- @method fileSelectionComplete@ Only show files matching pattern.
+-- | Only show files matching pattern.
 --
 fileSelectionComplete :: FileSelectionClass fsel => fsel -> String -> IO ()
 fileSelectionComplete fsel pattern =

Index: Window.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/windows/Window.chs,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- Window.chs	9 Jul 2003 22:42:46 -0000	1.6
+++ Window.chs	23 May 2004 16:17:53 -0000	1.7
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Window@
+--  GIMP Toolkit (GTK) Window
 --
 --  Author : Manuel M. T. Chakravarty, Axel Simon
 --          
@@ -19,13 +19,9 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
---
--- @documentation@ ------------------------------------------------------------
---
+-- |
 --
--- @todo@ ---------------------------------------------------------------------
+-- TODO
 --
 -- * missing but possibly useful methods are commented out
 --      
@@ -83,19 +79,19 @@
 
 -- methods
 
--- @constructor windowNew@ Create a new window of the given type.
+-- | Create a new window of the given type.
 --
 windowNew :: IO Window
 windowNew = makeNewObject mkWindow $ liftM castPtr $
   {#call window_new#} ((fromIntegral.fromEnum) WindowToplevel)
 
--- @method windowSetTitle@ set the title string of the given window
+-- | set the title string of the given window
 --
 windowSetTitle :: WindowClass w => w -> String -> IO ()
 windowSetTitle w str = 
   withUTFString str ({#call window_set_title#} (toWindow w))
 
--- @method windowSetResizable@ Sets whether the user can resize a window.
+-- | Sets whether the user can resize a window.
 --
 -- * Windows are user resizable by default.
 --
@@ -103,20 +99,20 @@
 windowSetResizable w res = 
   {#call window_set_resizable#} (toWindow w) (fromBool res)
 
--- @method windowGetResizable@ Retrieve the value set by
--- @ref method windowSetResizable@.
+-- | Retrieve the value set by
+-- 'windowSetResizable'.
 --
 windowGetResizable :: WindowClass w => w -> IO Bool
 windowGetResizable w = liftM toBool $ 
   {#call unsafe window_get_resizable#} (toWindow w)
 
--- @method windowActivateFocus@ dunno
+-- | dunno
 --
 windowActivateFocus :: WindowClass w => w -> IO Bool
 windowActivateFocus w = 
   liftM toBool $ {#call window_activate_focus#} (toWindow w)
 
--- @method windowActivateDefault@ dunno
+-- | dunno
 --
 windowActivateDefault :: WindowClass w => w -> IO Bool
 windowActivateDefault w = 
@@ -129,33 +125,33 @@
 windowSetPolicy w shrink grow auto = {#call window_set_policy#} 
   (toWindow w) (fromBool shrink) (fromBool grow) (fromBool auto)
 
--- @method windowSetModal@ make a window application modal
+-- | make a window application modal
 --
 windowSetModal :: WindowClass w => w -> Bool -> IO ()
 windowSetModal w m = {#call window_set_modal#} (toWindow w) (fromBool m)
 
--- @method windowSetDefaultSize@ set window default size
+-- | set window default size
 --
--- * Sets the default size of a window. If the window's "natural" size (its
+-- * Sets the default size of a window. If the window's \"natural\" size (its
 --   size request) is larger than the default, the default will be ignored.
 --   More generally, if the default size does not obey the geometry hints for
---   the window (@method windowSetGeometryHints@ can be used to set these
+--   the window ('windowSetGeometryHints' can be used to set these
 --   explicitly), the default size will be clamped to the nearest permitted
 --   size.
 --
--- * Unlike @ref arg widgetSetSizeRequest@, which sets a size request for a
+-- * Unlike @widgetSetSizeRequest@, which sets a size request for a
 --   widget and thus would keep users from shrinking the window, this function
 --   only sets the initial size, just as if the user had resized the window
 --   themselves. Users can still shrink the window again as they normally
---   would. Setting a default size of -1 means to use the "natural" default
+--   would. Setting a default size of -1 means to use the \"natural\" default
 --   size (the size request of the window).
 --
 -- * For more control over a window's initial size and how resizing works,
---   investigate @ref method windowSetGeometryHints@.
+--   investigate 'windowSetGeometryHints'.
 --
--- * For some uses, @ref method windowResize@ is a more appropriate function.
---   @ref method windowResize@ changes the current size of the window, rather
---   than the size to be used on initial display. @ref method windowResize@
+-- * For some uses, 'windowResize' is a more appropriate function.
+--   'windowResize' changes the current size of the window, rather
+--   than the size to be used on initial display. 'windowResize'
 --   always affects the window itself, not the geometry widget.The default
 --   size of a window only affects the first time a window is shown; if a
 --   window is hidden and re-shown, it will remember the size it had prior to
@@ -168,52 +164,52 @@
   {#call window_set_default_size#} (toWindow w) (fromIntegral height)
   (fromIntegral width)
 
--- @method windowSetPosition@ set the window position policy
+-- | set the window position policy
 --
 windowSetPosition :: WindowClass w => w -> WindowPosition -> IO ()
 windowSetPosition w pos = 
   {#call window_set_position#} (toWindow w) ((fromIntegral.fromEnum) pos)
 
--- @method windowSetTransientFor@ set transient window
+-- | set transient window
 --
 windowSetTransientFor :: (WindowClass win, WindowClass parent) => win ->
                          parent -> IO ()
 windowSetTransientFor w p = 
   {#call window_set_transient_for#} (toWindow w) (toWindow p)
 
--- @method windowSetDestroyWithParent@ destory transient window with parent
+-- | destory transient window with parent
 --
 windowSetDestroyWithParent :: WindowClass w => w -> Bool -> IO ()
 windowSetDestroyWithParent w b = 
   {#call window_set_destroy_with_parent#} (toWindow w) (fromBool b)
 
--- @method windowDeiconify@ restore the window
+-- | restore the window
 --
 windowDeiconify :: WindowClass w => w -> IO ()
 windowDeiconify w = {#call window_deiconify#} (toWindow w)
 
--- @method windowIconify@ minimize the window
+-- | minimize the window
 --
 windowIconify :: WindowClass w => w -> IO ()
 windowIconify w = {#call window_iconify#} (toWindow w)
 
--- @method windowMaximize@ maximize the window
+-- | maximize the window
 --
 windowMaximize :: WindowClass w => w -> IO ()
 windowMaximize w = {#call window_maximize#} (toWindow w)
 
--- @method windowUnmaximize@ unmaximize the window
+-- | unmaximize the window
 --
 windowUnmaximize :: WindowClass w => w -> IO ()
 windowUnmaximize w = {#call window_unmaximize#} (toWindow w)
 
--- @method windowSetDecorated@ remove the border
+-- | remove the border
 --
 windowSetDecorated :: WindowClass w => w -> Bool -> IO ()
 windowSetDecorated w b =
   {#call window_set_decorated#} (toWindow w) (fromBool b)
 
--- @method windowSetFrameDimensions@ set border widths
+-- | set border widths
 --
 windowSetFrameDimensions :: WindowClass w => w -> Int -> Int -> Int -> Int ->
                             IO ()
@@ -221,32 +217,32 @@
  {#call window_set_frame_dimensions#} (toWindow w) (fromIntegral left)
  (fromIntegral top) (fromIntegral right) (fromIntegral bottom)
 
--- @method windowSetRole@ set role (additional window name for the WM)
+-- | set role (additional window name for the WM)
 --
 windowSetRole :: WindowClass w => w -> String -> IO ()
 windowSetRole w str = 
   withUTFString str ({#call window_set_role#} (toWindow w))
 
--- @method windowStick@ show the window on every workspace
+-- | show the window on every workspace
 --
 windowStick :: WindowClass w => w -> IO ()
 windowStick w = {#call window_stick#} (toWindow w)
 
--- @method windowUnstick@ do not show the window on every workspace
+-- | do not show the window on every workspace
 --
 windowUnstick :: WindowClass w => w -> IO ()
 windowUnstick w = {#call window_unstick#} (toWindow w)
 
 -- signals
 
--- @signal connectToFrameEvent@ 
+-- | 
 --
 onFrameEvent, afterFrameEvent :: WindowClass w => w -> (Event -> IO Bool) ->
                                  IO (ConnectId w)
 onFrameEvent = connect_BOXED__BOOL "frame_event" marshalEvent False
 afterFrameEvent = connect_BOXED__BOOL "frame_event" marshalEvent True
 
--- @signal connectToSetFocus@ 
+-- | 
 --
 onSetFocus, afterSetFocus :: (WindowClass w, WidgetClass foc) => w ->
                              (foc -> IO ()) -> IO (ConnectId w)

[Gtk2hs-commit] gtk2hs ChangeLog,1.168,1.169

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv19222

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.168
retrieving revision 1.169
diff -u -d -r1.168 -r1.169
--- ChangeLog	23 May 2004 16:16:44 -0000	1.168
+++ ChangeLog	23 May 2004 16:17:53 -0000	1.169
@@ -86,6 +86,10 @@
 	gtk/treeList/TreeStore.chs, gtk/treeList/TreeView.chs,
 	gtk/treeList/TreeViewColumn.chs: initial haddockification
 
+	* gtk/windows/Dialog.chs, gtk/windows/FileChooserDialog.chs,
+	gtk/windows/FileSel.chs, gtk/windows/Window.chs:
+	initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs ChangeLog,1.167,1.168

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18736

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.167
retrieving revision 1.168
diff -u -d -r1.167 -r1.168
--- ChangeLog	23 May 2004 16:14:10 -0000	1.167
+++ ChangeLog	23 May 2004 16:16:44 -0000	1.168
@@ -77,6 +77,15 @@
 	* gtk/scrolling/HScrollbar.chs, gtk/scrolling/ScrolledWindow.chs,
 	gtk/scrolling/VScrollbar.chs: initial haddockification
 
+	* gtk/treeList/CellRenderer.hs,
+	gtk/treeList/CellRendererPixbuf.chs,
+	gtk/treeList/CellRendererText.chs,
+	gtk/treeList/CellRendererToggle.chs, gtk/treeList/ListStore.chs,
+	gtk/treeList/StoreValue.hsc, gtk/treeList/TreeModel.chs,
+	gtk/treeList/TreeModelSort.chs,	gtk/treeList/TreeSelection.chs,
+	gtk/treeList/TreeStore.chs, gtk/treeList/TreeView.chs,
+	gtk/treeList/TreeViewColumn.chs: initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs ChangeLog,1.166,1.167

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18418

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.166
retrieving revision 1.167
diff -u -d -r1.166 -r1.167
--- ChangeLog	23 May 2004 16:12:21 -0000	1.166
+++ ChangeLog	23 May 2004 16:14:10 -0000	1.167
@@ -74,6 +74,9 @@
 	gtk/pango/PangoTypes.chs, gtk/pango/Rendering.chs:
 	initial haddockification
 
+	* gtk/scrolling/HScrollbar.chs, gtk/scrolling/ScrolledWindow.chs,
+	gtk/scrolling/VScrollbar.chs: initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs/gtk/scrolling HScrollbar.chs,1.4,1.5 ScrolledWindow.chs,1.6,1.7 VScrollbar.chs,1.4,1.5

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

Update of /cvsroot/gtk2hs/gtk2hs/gtk/scrolling
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18418/gtk/scrolling

Modified Files:
	HScrollbar.chs ScrolledWindow.chs VScrollbar.chs 
Log Message:
initial haddockification


Index: VScrollbar.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/scrolling/VScrollbar.chs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- VScrollbar.chs	9 Jul 2003 22:42:45 -0000	1.4
+++ VScrollbar.chs	23 May 2004 16:14:09 -0000	1.5
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget VScrollbar@
+--  GIMP Toolkit (GTK) Widget VScrollbar
 --
 --  Author : Axel Simon
 --          
@@ -19,15 +19,11 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * This widget provides a stand-alone scrollbar. All interesting functions
---   can be found in @ref data Range@, from which it is derived.
---
--- @documentation@ ------------------------------------------------------------
+-- |
 --
+-- This widget provides a stand-alone scrollbar. All interesting functions
+-- can be found in 'Range', from which it is derived.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module VScrollbar(
   VScrollbar,
@@ -47,7 +43,7 @@
 
 -- methods
 
--- @constructor vScrollbarNew@ Create a new HScrollbar.
+-- | Create a new HScrollbar.
 --
 vScrollbarNew :: Adjustment -> IO VScrollbar
 vScrollbarNew adj = makeNewObject mkVScrollbar $ liftM castPtr $

Index: ScrolledWindow.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/scrolling/ScrolledWindow.chs,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- ScrolledWindow.chs	9 Jul 2003 22:42:45 -0000	1.6
+++ ScrolledWindow.chs	23 May 2004 16:14:09 -0000	1.7
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget ScrolledWindow@
+--  GIMP Toolkit (GTK) Widget ScrolledWindow
 --
 --  Author : Axel Simon
 --          
@@ -19,20 +19,15 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
+-- |
 --
--- * @ref data ScrolledWindow@ is a container that adds scroll bars to its 
---   child. Some
---   widgets have native scrolling support, in which case the scrolling action
+-- 'ScrolledWindow' is a container that adds scroll bars to its child
+--
+-- * Some widgets have native scrolling support, in which case the scrolling action
 --   is performed by the child itself (e.g. a TreeView widget does this by only
 --   moving the table part and not the titles of a table). If a widget does
---   not support native scrolling it can be put into a 
---   @ref data ScrolledWindow@ widget.
---
--- @documentation@ ------------------------------------------------------------
---
+--   not support native scrolling it can be put into a 'ScrolledWindow' widget.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module ScrolledWindow(
   ScrolledWindow,
@@ -65,7 +60,7 @@
 
 -- methods
 
--- @constructor scrolledWindowNew@ Create a new @ref data ScrolledWindow@.
+-- | Create a new 'ScrolledWindow'.
 --
 scrolledWindowNew :: Maybe Adjustment -> Maybe Adjustment -> IO ScrolledWindow
 scrolledWindowNew hAdj vAdj = makeNewObject mkScrolledWindow $ liftM castPtr $
@@ -74,21 +69,21 @@
  fromMAdj :: Maybe Adjustment -> Adjustment
  fromMAdj = fromMaybe $ mkAdjustment nullForeignPtr
 
--- @method scrolledWindowGetHAdjustment@ Retrieve the horizontal
--- @ref data Adjustment@ of the @ref data ScrolledWindow@.
+-- | Retrieve the horizontal
+-- 'Adjustment' of the 'ScrolledWindow'.
 --
 scrolledWindowGetHAdjustment :: ScrolledWindowClass w => w -> IO Adjustment
 scrolledWindowGetHAdjustment w = makeNewObject mkAdjustment $
   {#call unsafe scrolled_window_get_hadjustment#} (toScrolledWindow w)
 
--- @method scrolledWindowGetVAdjustment@ Retrieve the vertical
--- @ref data Adjustment@ of the @ref data ScrolledWindow@.
+-- | Retrieve the vertical
+-- 'Adjustment' of the 'ScrolledWindow'.
 --
 scrolledWindowGetVAdjustment :: ScrolledWindowClass w => w -> IO Adjustment
 scrolledWindowGetVAdjustment w = makeNewObject mkAdjustment $
   {#call unsafe scrolled_window_get_vadjustment#} (toScrolledWindow w)
 
--- @method scrolledWindowSetPolicy@ Specify if the scrollbars should vanish if
+-- | Specify if the scrollbars should vanish if
 -- the child size is sufficiently small.
 --
 scrolledWindowSetPolicy :: ScrolledWindowClass w => w -> PolicyType ->
@@ -97,8 +92,8 @@
   (toScrolledWindow w) ((fromIntegral.fromEnum) hPol) 
   ((fromIntegral.fromEnum) vPol)
 
--- @method scrolledWindowAddWithViewport@ Add a child widget without native
--- scrolling support to this @ref data ScrolledWindow@.
+-- | Add a child widget without native
+-- scrolling support to this 'ScrolledWindow'.
 --
 scrolledWindowAddWithViewport :: (ScrolledWindowClass w, WidgetClass wid) => 
                                  w -> wid -> IO ()
@@ -106,7 +101,7 @@
   {#call scrolled_window_add_with_viewport#} (toScrolledWindow w) 
   (toWidget wid)
 
--- @method scrolledWindowSetPlacement@ Specify where the scrollbars should be
+-- | Specify where the scrollbars should be
 -- placed.
 --
 scrolledWindowSetPlacement :: ScrolledWindowClass w => w -> CornerType -> IO ()
@@ -114,7 +109,7 @@
   {#call scrolled_window_set_placement#} (toScrolledWindow w)
   ((fromIntegral.fromEnum) ct)
 
--- @method scrolledWindowSetShadowType@ Specify if and how an outer frame
+-- | Specify if and how an outer frame
 -- should be drawn around the child.
 --
 scrolledWindowSetShadowType :: ScrolledWindowClass w => w -> ShadowType ->
@@ -122,16 +117,16 @@
 scrolledWindowSetShadowType w st = {#call scrolled_window_set_shadow_type#}
   (toScrolledWindow w) ((fromIntegral.fromEnum) st)
 
--- @method scrolledWindowSetHAdjustment@ Set the horizontal
--- @ref data Adjustment@ of the @ref data ScrolledWindow@.
+-- | Set the horizontal
+-- 'Adjustment' of the 'ScrolledWindow'.
 --
 scrolledWindowSetHAdjustment :: ScrolledWindowClass w => w -> Adjustment ->
                                 IO ()
 scrolledWindowSetHAdjustment w adj = {#call scrolled_window_set_hadjustment#}
   (toScrolledWindow w) adj
 
--- @method scrolledWindowSetVAdjustment@ Set the vertical @ref data Adjustment@
--- of the @ref data ScrolledWindow@.
+-- | Set the vertical 'Adjustment'
+-- of the 'ScrolledWindow'.
 --
 scrolledWindowSetVAdjustment :: ScrolledWindowClass w => w -> Adjustment ->
                                 IO ()

Index: HScrollbar.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/scrolling/HScrollbar.chs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- HScrollbar.chs	9 Jul 2003 22:42:45 -0000	1.4
+++ HScrollbar.chs	23 May 2004 16:14:09 -0000	1.5
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget HScrollbar@
+--  GIMP Toolkit (GTK) Widget HScrollbar
 --
 --  Author : Axel Simon
 --          
@@ -19,15 +19,11 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * This widget provides a stand-alone scrollbar. All interesting functions
---   can be found in @ref data Range@, from which it is derived.
---
--- @documentation@ ------------------------------------------------------------
+-- |
 --
+-- This widget provides a stand-alone scrollbar. All interesting functions
+-- can be found in 'Range', from which it is derived.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module HScrollbar(
   HScrollbar,
@@ -47,7 +43,7 @@
 
 -- methods
 
--- @constructor hScrollbarNew@ Create a new HScrollbar.
+-- | Create a new HScrollbar.
 --
 hScrollbarNew :: Adjustment -> IO HScrollbar
 hScrollbarNew adj = makeNewObject mkHScrollbar $ liftM castPtr $

[Gtk2hs-commit] gtk2hs/gtk/pango Markup.hs,1.5,1.6 PangoLayout.chs,1.6,1.7 PangoTypes.chs,1.3,1.4 Rendering.chs,1.2,1.3

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

Update of /cvsroot/gtk2hs/gtk2hs/gtk/pango
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18001/gtk/pango

Modified Files:
	Markup.hs PangoLayout.chs PangoTypes.chs Rendering.chs 
Log Message:
initial haddockification


Index: Markup.hs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/pango/Markup.hs,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- Markup.hs	9 Feb 2003 10:43:01 -0000	1.5
+++ Markup.hs	23 May 2004 16:12:20 -0000	1.6
@@ -1,4 +1,4 @@
---  GIMP Toolkit (GTK) @entry Markup@
+--  GIMP Toolkit (GTK) Markup
 --
 --  Author : Axel Simon
 --          
@@ -18,17 +18,14 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * This module defines some helper functions for generating texts with
---   embedded attributes.
---
--- @documentation@ ------------------------------------------------------------
+-- |
 --
+-- This module defines some helper functions for generating texts with
+-- embedded attributes.
 --
--- @todo@ ---------------------------------------------------------------------
+-- TODO
 --
--- * Add a numeric value to @ref data FontWeightDef@.
+-- * Add a numeric value to 'FontWeightDef'.
 --
 module Markup(
   Markup,
@@ -43,75 +40,75 @@
   ) where
 
 
--- @type Markup@ Define a synonym for text with embedded markup commands.
+-- | Define a synonym for text with embedded markup commands.
 --
 -- * Markup strings are just simple strings. But it's easier to tell if a
 --   method expects text with or without markup.
 --
 type Markup = String
 
--- @data SpanAttribute@ These are all the attributes the
--- @ref function markSpan@ function can express.
+-- | These are all the attributes the
+-- 'markSpan' function can express.
 --
--- @variant FontDescr@ Choose a font by textual description.
+-- DOCFIXME(constructor): FontDescr Choose a font by textual description.
 --
 -- * Takes a
---   string to completely describe the font, example: @ref variant FontDescr@ 
---   @literal "Sans Italic 12"@
+--   string to completely describe the font, example: 'FontDescr' 
+--   @"Sans Italic 12"@
 --
--- @variant FontFamily@ Specify the family of font to use.
+-- DOCFIXME(constructor): FontFamily Specify the family of font to use.
 --
--- * Example: @ref variant FontFamily@ @literal "Sans"@
+-- * Example: 'FontFamily' @"Sans"@
 --
--- @variant FontSize@ Change the size of the current font.
+-- DOCFIXME(constructor): FontSize Change the size of the current font.
 --
 -- * The constuctor takes the size in points (pt) or as predefined
 --   sizes. Setting the absolute size 12.5pt can be achieved by passing
---   @ref variant FontSize@ @literal (@ @ref variant FSPoint@ 
---   @literal 12.5)@ to @ref function markSpan@. Next to predefined absolute
---   sizes such as @ref variant FSsmall@ the size can be changed by asking for
---   the next larger or smaller front with @ref variant FSlarger@ and
---   @ref variant FSsmaller@, respectively.
+--   'FontSize' @('FSPoint' 
+--   @12.5)@ to 'markSpan'. Next to predefined absolute
+--   sizes such as 'FSsmall' the size can be changed by asking for
+--   the next larger or smaller front with 'FSlarger' and
+--   'FSsmaller', respectively.
 --
--- @variant FontStyle@ Change the slant of the current font.
+-- DOCFIXME(constructor): FontStyle Change the slant of the current font.
 --
--- * The constructor takes one of three styles: @ref variant FYnormal@,
---   @ref variant FYoblique@ or @ref variant FYitalic@.
+-- * The constructor takes one of three styles: 'FYnormal',
+--   'FYoblique' or 'FYitalic'.
 --
--- @variant FontWeight@ Change the thickness of the current font.
+-- DOCFIXME(constructor): FontWeight Change the thickness of the current font.
 --
 -- * The constructor takes one of the six predefined weights. Most likely to
---   be supported: @ref variant FWbold@.
+--   be supported: 'FWbold'.
 --
--- @variant FontVariant@ Choosing an alternative rendering for lower case
+-- DOCFIXME(constructor): FontVariant Choosing an alternative rendering for lower case
 -- letters.
 --
--- * The argument @ref variant FVsmallcaps@ will display lower case letters
+-- * The argument 'FVsmallcaps' will display lower case letters
 --   as smaller upper case letters, if this option is available.
 --
--- @variant FontStretch@ Choose a different width.
+-- DOCFIXME(constructor): FontStretch Choose a different width.
 --
--- * Takes one of nine font widths, e.g. @ref variant FTcondensed@ or
---   @ref variant FTexpanded@.
+-- * Takes one of nine font widths, e.g. 'FTcondensed' or
+--   'FTexpanded'.
 --
--- @variant FontForeground@ Foreground color.
+-- DOCFIXME(constructor): FontForeground Foreground color.
 --
--- * This constructor and @ref variant FontBackground@ take both a description
+-- * This constructor and 'FontBackground' take both a description
 --   of the color to be used for rendering.
 --
--- @variant FontBackground@ Background color.
+-- DOCFIXME(constructor): FontBackground Background color.
 --
--- @variant FontUnderline@ Specify underlining of text.
+-- DOCFIXME(constructor): FontUnderline Specify underlining of text.
 --
--- * @ref variant FUnone@, @ref variant FUsingle@, @ref variant FUdouble@ or
---   @ref variant  FUlow@ are possible choices.
+-- * 'FUnone', 'FUsingle', 'FUdouble' or
+--   'FUlow' are possible choices.
 --
--- @variant FontRise@ Specify a vertical displacement.
+-- DOCFIXME(constructor): FontRise Specify a vertical displacement.
 --
--- * Takes the vertical displacement in em (the width of the 'm' character
+-- * Takes the vertical displacement in em (the width of the \'m\' character
 --   in the current font).
 --
--- @variant FontLang@ Give a hint about the language to be displayed.
+-- DOCFIXME(constructor): FontLang Give a hint about the language to be displayed.
 --
 data SpanAttribute
   = FontDescr   String
@@ -142,7 +139,7 @@
 				   (show (round (r*10000)))
   showsPrec _ (FontLang l)	 = showString " lang=".shows l
 
--- @data FontSizeDef@ Define attributes for @ref type FontSize@.
+-- | Define attributes for 'FontSize'.
 --
 data FontSizeDef
   = FSPoint Double
@@ -168,7 +165,7 @@
   showsPrec _ (FSsmaller)	  = shows "smaller"
   showsPrec _ (FSlarger)	  = shows "larger"
 
--- @data FontStyleDef@ Define attributes for @ref type FontStyle@.
+-- | Define attributes for 'FontStyle'.
 --
 data FontStyleDef
   = FYnormal
@@ -180,7 +177,7 @@
   showsPrec _ FYoblique	   = shows "oblique"
   showsPrec _ FYitalic	   = shows "italic"
 
--- @data FontWeightDef@ Define attributes for @ref type FontWeight@.
+-- | Define attributes for 'FontWeight'.
 --
 data FontWeightDef
   = FWultralight
@@ -198,7 +195,7 @@
   showsPrec _ FWultrabold  = shows "ultrabold"
   showsPrec _ FWheavy	   = shows "heavy"
 
--- @data FontVariantDef@ Define attributes for @ref type FontVariant@.
+-- | Define attributes for 'FontVariant'.
 --
 data FontVariantDef
   = FVnormal
@@ -208,7 +205,7 @@
   showsPrec _ FVnormal	     = shows "normal"
   showsPrec _ FVsmallcaps    = shows "smallcaps"
 
--- @data FontStretchDef@ Define attributes for @ref type FontStretch@.
+-- | Define attributes for 'FontStretch'.
 --
 data FontStretchDef
   = FTultracondensed
@@ -232,7 +229,7 @@
   showsPrec _ FTextraexpanded	= shows "extraexpanded"
   showsPrec _ FTultraexpanded	= shows "ultraexpanded"
 
--- @data FontUnderlineDef@ Define attributes for @ref type FontUnderline@.
+-- | Define attributes for 'FontUnderline'.
 --
 data FontUnderlineDef
   = FUsingle
@@ -246,7 +243,7 @@
   showsPrec _ FUlow	= shows "low"
   showsPrec _ FUnone	= shows "none"
 
--- @method markSpan@ Create the most generic span attribute.
+-- | Create the most generic span attribute.
 --
 markSpan :: [SpanAttribute] -> String -> String
 markSpan attrs text = showString "<span".

Index: PangoTypes.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/pango/PangoTypes.chs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- PangoTypes.chs	9 Jul 2003 22:42:45 -0000	1.3
+++ PangoTypes.chs	23 May 2004 16:12:20 -0000	1.4
@@ -1,5 +1,5 @@
 {-# OPTIONS -cpp #-}
---  GIMP Toolkit (GTK) - pango non-GObject types @entry PangoTypes@
+--  GIMP Toolkit (GTK) - pango non-GObject types PangoTypes
 --
 --  Author : Axel Simon
 --          
@@ -19,15 +19,9 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * Define types used in Pango which are not derived from GObject.
---
--- @documentation@ ------------------------------------------------------------
---
---
--- @todo@ ---------------------------------------------------------------------
+-- |
 --
+-- Define types used in Pango which are not derived from GObject.
 --
 module PangoTypes(
   LayoutIter(LayoutIter),
@@ -41,13 +35,13 @@
 
 {# context lib="pango" prefix="pango" #}
 
--- @entry PangoLayout@
+-- entry PangoLayout
 
--- @data LayoutIter@ An iterator to examine a layout.
+-- | An iterator to examine a layout.
 --
 {#pointer *PangoLayoutIter as LayoutIter foreign newtype #}
 
--- @data LayoutLine@ A single line in a @ref data PangoLayout@.
+-- | A single line in a 'PangoLayout'.
 --
 {#pointer *PangoLayoutLine as LayoutLine foreign newtype #}
 

Index: PangoLayout.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/pango/PangoLayout.chs,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- PangoLayout.chs	9 Jul 2003 22:42:45 -0000	1.6
+++ PangoLayout.chs	23 May 2004 16:12:20 -0000	1.7
@@ -1,4 +1,4 @@
---  GIMP Toolkit (GTK) - text layout functions @entry PangoLayout@
+--  GIMP Toolkit (GTK) - text layout functions PangoLayout
 --
 --  Author : Axel Simon
 --          
@@ -18,17 +18,15 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * Functions to run the rendering pipeline.
+-- |
 --
--- @documentation@ ------------------------------------------------------------
+-- Functions to run the rendering pipeline.
 --
 -- * The Pango rendering pipeline takes a string of Unicode characters
 --   and converts it into glyphs.  The functions described in this module
 --   accomplish various steps of this process.
 --
--- @todo@ ---------------------------------------------------------------------
+-- TODO
 --
 -- * Functions that are missing:
 --   pango_layout_set_attributes, pango_layout_get_attributes,
@@ -36,7 +34,7 @@
 --   pango_layout_get_tabs, pango_layout_get_log_attrs, 
 --   pango_layout_iter_get_run
 --
--- * The following functions cannot be bound easily due to Unicode/UTF8 issues:
+-- * The following functions cannot be bound easily due to Unicode\/UTF8 issues:
 --   pango_layout_xy_to_index, pango_layout_index_to_pos,
 --   pango_layout_get_cursor_pos, pango_layout_move_cursor_visually,
 --   pango_layout_iter_get_index, pango_layout_line_index_to_x,
@@ -107,22 +105,22 @@
 
 {# context lib="pango" prefix="pango" #}
 
--- @method layoutCopy@ Create a copy of the @ref data Layout@.
+-- | Create a copy of the 'Layout'.
 --
 layoutCopy :: PangoLayout -> IO PangoLayout
 layoutCopy pl = makeNewGObject mkPangoLayout 
 		 ({#call unsafe layout_copy#} (toPangoLayout pl))
 
--- @method layoutGetContext@ Retrieves the @ref data PangoContext@ from this
+-- | Retrieves the 'PangoContext' from this
 -- layout.
 --
 layoutGetContext :: PangoLayout -> IO PangoContext
 layoutGetContext pl = makeNewGObject mkPangoContext
 		      ({#call unsafe layout_get_context#} pl)
 
--- @method layoutContextChanged@ Signal a @ref data Context@ change.
+-- | Signal a 'Context' change.
 --
--- * Forces recomputation of any state in the @ref data PangoLayout@ that
+-- * Forces recomputation of any state in the 'PangoLayout' that
 --   might depend on the layout's context. This function should
 --   be called if you make changes to the context subsequent
 --   to creating the layout.
@@ -130,28 +128,28 @@
 layoutContextChanged :: PangoLayout -> IO ()
 layoutContextChanged pl = {#call unsafe layout_context_changed#} pl
 
--- @method layoutSetText@ Set the string in the layout.
+-- | Set the string in the layout.
 --
 layoutSetText :: PangoLayout -> String -> IO ()
 layoutSetText pl txt = withUTFStringLen txt $ \(strPtr,len) ->
   {#call unsafe layout_set_text#} pl strPtr (fromIntegral len)
 
--- @method layoutGetText@ Retrieve the string in the layout.
+-- | Retrieve the string in the layout.
 --
 layoutGetText :: PangoLayout -> IO String
 layoutGetText pl = {#call unsafe layout_get_text#} pl >>= peekUTFString
 
--- @method layoutSetMarkup@ Set the string in the layout.
+-- | Set the string in the layout.
 --
--- * The string may include @ref data Markup@.
+-- * The string may include 'Markup'.
 --
 layoutSetMarkup :: PangoLayout -> Markup -> IO ()
 layoutSetMarkup pl txt = withUTFStringLen txt $ \(strPtr,len) ->
   {#call unsafe layout_set_markup#} pl strPtr (fromIntegral len)
 
--- @method layoutSetMarkupWithAccel@ Set the string in the layout.
+-- | Set the string in the layout.
 --
--- * The string may include @ref data Markup@. Furthermore, any underscore
+-- * The string may include 'Markup'. Furthermore, any underscore
 --   character indicates that the next character should be
 --   marked as accelerator (i.e. underlined). A literal underscore character
 --   can be produced by placing it twice in the string.
@@ -170,44 +168,44 @@
 
 -- there are a couple of functions missing here
 
--- @method layoutSetWidth@ Set the width of this paragraph.
+-- | Set the width of this paragraph.
 --
--- * Sets the width to which the lines of the @ref data PangoLayout@
+-- * Sets the width to which the lines of the 'PangoLayout'
 --   should be wrapped.
 --
--- * @ref arg width@ is the desired width, or @literal -1@ to indicate that
+-- * @width@ is the desired width, or @-1@ to indicate that
 --   no wrapping should be performed.
 --
 layoutSetWidth :: PangoLayout -> Int -> IO ()
 layoutSetWidth pl width =
   {#call unsafe layout_set_width#} pl (fromIntegral width)
 
--- @method layoutGetWidth@ Gets the width of this paragraph.
+-- | Gets the width of this paragraph.
 --
--- * Gets the width to which the lines of the @ref data PangoLayout@
+-- * Gets the width to which the lines of the 'PangoLayout'
 --   should be wrapped.
 --
--- * Returns is the current width, or @literal -1@ to indicate that
+-- * Returns is the current width, or @-1@ to indicate that
 --   no wrapping is performed.
 --
 layoutGetWidth :: PangoLayout -> IO Int
 layoutGetWidth pl = liftM fromIntegral $ {#call unsafe layout_get_width#} pl
 
 
--- @data LayoutWarpMode@ Enumerates how a line can be wrapped.
+-- | Enumerates how a line can be wrapped.
 --
--- @variant WrapWholeWords@ Breaks lines only between words.
+-- DOCFIXME(constructor): WrapWholeWords Breaks lines only between words.
 --
 -- * This variant does not guarantee that the requested width is not
 --   exceeded. A word that is longer than the paragraph width is not
 --   split.
 
--- @variant WrapAnywhere@ Break lines anywhere.
+-- DOCFIXME(constructor): WrapAnywhere Break lines anywhere.
 --
--- @variant WrapPartialWords@ Wrap within a word if it is the only one on
+-- DOCFIXME(constructor): WrapPartialWords Wrap within a word if it is the only one on
 -- this line.
 --
--- * This option acts like @ref variant WrapWholeWords@ but will split
+-- * This option acts like 'WrapWholeWords' but will split
 --   a word if it is the only one on this line and it exceeds the
 --   specified width.
 --
@@ -217,10 +215,10 @@
   PANGO_WRAP_CHAR as WrapAnywhere,
   PANGO_WRAP_WORD_CHAR as WrapPartialWords}#}
 
--- @method layoutSetWrap@ Set how this paragraph is wrapped.
+-- | Set how this paragraph is wrapped.
 --
 -- * Sets the wrap style; the wrap style only has an effect if a width
---   is set on the layout with @ref method layoutSetWidth@. To turn off
+--   is set on the layout with 'layoutSetWidth'. To turn off
 --   wrapping, set the width to -1.
 --
 layoutSetWrap :: PangoLayout -> LayoutWrapMode -> IO ()
@@ -228,13 +226,13 @@
   {#call unsafe layout_set_wrap#} pl ((fromIntegral.fromEnum) wm)
 
 
--- @method layoutGetWrap@ Get the wrap mode for the layout.
+-- | Get the wrap mode for the layout.
 --
 layoutGetWrap :: PangoLayout -> IO LayoutWrapMode
 layoutGetWrap pl = liftM (toEnum.fromIntegral) $
   {#call unsafe layout_get_wrap#} pl
 
--- @method layoutSetIndent@ Set the indentation of this paragraph.
+-- | Set the indentation of this paragraph.
 --
 -- * Sets the amount by which the first line should be shorter than
 --   the rest of the lines. This may be negative, in which case the
@@ -246,7 +244,7 @@
 layoutSetIndent pl indent =
   {#call unsafe layout_set_indent#} pl (fromIntegral indent)
 
--- @method layoutGetIndent@ Gets the indentation of this paragraph.
+-- | Gets the indentation of this paragraph.
 --
 -- * Gets the amount by which the first line should be shorter than 
 --   the rest of the lines.
@@ -255,19 +253,19 @@
 layoutGetIndent pl = liftM fromIntegral $ {#call unsafe layout_get_indent#} pl
 
 
--- @method layoutSetSpacing@ Set the spacing between lines of this paragraph.
+-- | Set the spacing between lines of this paragraph.
 --
 layoutSetSpacing :: PangoLayout -> Int -> IO ()
 layoutSetSpacing pl spacing =
   {#call unsafe layout_set_spacing#} pl (fromIntegral spacing)
 
--- @method layoutGetSpacing@ Gets the spacing between the lines.
+-- | Gets the spacing between the lines.
 --
 layoutGetSpacing :: PangoLayout -> IO Int
 layoutGetSpacing pl = 
   liftM fromIntegral $ {#call unsafe layout_get_spacing#} pl
 
--- @method layoutSetJustify@ Set if text should be streched to fit width.
+-- | Set if text should be streched to fit width.
 --
 -- * Sets whether or not each complete line should be stretched to
 --   fill the entire width of the layout. This stretching is typically
@@ -277,18 +275,18 @@
 layoutSetJustify :: PangoLayout -> Bool -> IO ()
 layoutSetJustify pl j = {#call unsafe layout_set_justify#} pl (fromBool j)
 
--- @method layoutGetJustify@ Retrieve the justification flag.
+-- | Retrieve the justification flag.
 --
--- * See @ref method layoutSetJustify@.
+-- * See 'layoutSetJustify'.
 --
 layoutGetJustify :: PangoLayout -> IO Bool
 layoutGetJustify pl = liftM toBool $ {#call unsafe layout_get_justify#} pl
 
--- @data LayoutAlignment@ Enumerate to which side incomplete lines are flushed.
+-- | Enumerate to which side incomplete lines are flushed.
 --
 {#enum PangoAlignment as LayoutAlignment {underscoreToCase}#}
 
--- @method layoutSetAlignment@ Set how this paragraph is aligned.
+-- | Set how this paragraph is aligned.
 --
 -- * Sets the alignment for the layout (how partial lines are
 --   positioned within the horizontal space available.)
@@ -298,7 +296,7 @@
   {#call unsafe layout_set_alignment#} pl ((fromIntegral.fromEnum) am)
 
 
--- @method layoutGetAlignment@ Get the alignment for the layout.
+-- | Get the alignment for the layout.
 --
 layoutGetAlignment :: PangoLayout -> IO LayoutAlignment
 layoutGetAlignment pl = liftM (toEnum.fromIntegral) $
@@ -306,9 +304,9 @@
 
 -- functions are missing here
 
--- @method layoutSetSingleParagraphMode@ Honor newlines or not.
+-- | Honor newlines or not.
 --
--- * If @ref arg honor@ is @literal True@, do not treat newlines and
+-- * If @honor@ is @True@, do not treat newlines and
 --   similar characters as paragraph separators; instead, keep all text in
 --   a single paragraph, and display a glyph for paragraph separator
 --   characters. Used when you want to allow editing of newlines on a
@@ -318,9 +316,9 @@
 layoutSetSingleParagraphMode pl honor = 
   {#call unsafe layout_set_single_paragraph_mode#} pl (fromBool honor)
 
--- @method layoutGetSingleParagraphMode@ Retrieve if newlines are honored.
+-- | Retrieve if newlines are honored.
 --
--- * See @ref method layoutSetSingleParagraphMode@.
+-- * See 'layoutSetSingleParagraphMode'.
 --
 layoutGetSingleParagraphMode :: PangoLayout -> IO Bool
 layoutGetSingleParagraphMode pl = 
@@ -328,15 +326,15 @@
 
 -- a function is missing here
 
--- @method layoutGetExtents@ Compute the physical size of the layout.
+-- | Compute the physical size of the layout.
 --
--- * Computes the logical and the ink size of the @ref data Layout@. The
+-- * Computes the logical and the ink size of the 'Layout'. The
 --   logical layout is used for positioning, the ink size is the smallest
 --   bounding box that includes all character pixels. The ink size can be
 --   smaller or larger that the logical layout.
 --
 -- * All values are in layout units. To get to device units (pixel for
---   @ref data Drawable@s) divide by @ref constant pangoScale@.
+--   'Drawable's) divide by 'pangoScale'.
 --
 layoutGetExtents :: PangoLayout -> IO (Rectangle, Rectangle)
 layoutGetExtents pl = alloca $ \logPtr -> alloca $ \inkPtr -> do
@@ -346,15 +344,15 @@
   return (log,ink)
 
 
--- @method layoutGetPixelExtents@ Compute the physical size of the layout.
+-- | Compute the physical size of the layout.
 --
--- * Computes the logical and the ink size of the @ref data Layout@. The
+-- * Computes the logical and the ink size of the 'Layout'. The
 --   logical layout is used for positioning, the ink size is the smallest
 --   bounding box that includes all character pixels. The ink size can be
 --   smaller or larger that the logical layout.
 --
 -- * All values are in device units. This function is a wrapper around
---   @ref method layoutGetExtents@ with scaling.
+--   'layoutGetExtents' with scaling.
 --
 layoutGetPixelExtents :: PangoLayout -> IO (Rectangle, Rectangle)
 layoutGetPixelExtents pl = alloca $ \logPtr -> alloca $ \inkPtr -> do
@@ -363,13 +361,13 @@
   ink <- peek inkPtr
   return (log,ink)
 
--- @method layoutGetLineCount@ Ask for the number of lines in this layout.
+-- | Ask for the number of lines in this layout.
 --
 layoutGetLineCount :: PangoLayout -> IO Int
 layoutGetLineCount pl = liftM fromIntegral $
   {#call unsafe layout_get_line_count#} pl
 
--- @method layoutGetLines@ Extract the single lines of the layout.
+-- | Extract the single lines of the layout.
 --
 -- * The lines of each layout are regenerated if any attribute changes.
 --   Thus the returned list does not reflect the current state of lines
@@ -381,50 +379,50 @@
   list <- readGSList listPtr
   mapM mkLayoutLine list
 
--- @constructor layoutGetIter@ Create an iterator to examine a layout.
+-- | Create an iterator to examine a layout.
 --
 layoutGetIter :: PangoLayout -> IO LayoutIter
 layoutGetIter pl = do
   iterPtr <- {#call unsafe layout_get_iter#} pl
   liftM LayoutIter $ newForeignPtr iterPtr (layout_iter_free iterPtr)
 
--- @method layoutNextRun@ Move to the next run.
+-- | Move to the next run.
 --
--- * Returns @literal False@ if this was the last run in the layout.
+-- * Returns @False@ if this was the last run in the layout.
 --
 layoutIterNextRun :: LayoutIter -> IO Bool
 layoutIterNextRun = liftM toBool . {#call unsafe layout_iter_next_run#}
 
--- @method layoutNextChar@ Move to the next char.
+-- | Move to the next char.
 --
--- * Returns @literal False@ if this was the last char in the layout.
+-- * Returns @False@ if this was the last char in the layout.
 --
 layoutIterNextChar :: LayoutIter -> IO Bool
 layoutIterNextChar = liftM toBool . {#call unsafe layout_iter_next_char#}
 
--- @method layoutNextCluster@ Move to the next cluster.
+-- | Move to the next cluster.
 --
--- * Returns @literal False@ if this was the last cluster in the layout.
+-- * Returns @False@ if this was the last cluster in the layout.
 --
 layoutIterNextCluster :: LayoutIter -> IO Bool
 layoutIterNextCluster = liftM toBool . {#call unsafe layout_iter_next_cluster#}
 
--- @method layoutNextLine@ Move to the next line.
+-- | Move to the next line.
 --
--- * Returns @literal False@ if this was the last line in the layout.
+-- * Returns @False@ if this was the last line in the layout.
 --
 layoutIterNextLine :: LayoutIter -> IO Bool
 layoutIterNextLine = liftM toBool . {#call unsafe layout_iter_next_line#}
 
--- @method layoutAtLastLine@ Check if the iterator is on the last line.
+-- | Check if the iterator is on the last line.
 --
--- * Returns @literal True@ if the iterator is on the last line of this
+-- * Returns @True@ if the iterator is on the last line of this
 --   paragraph.
 --
 layoutIterAtLastLine :: LayoutIter -> IO Bool
 layoutIterAtLastLine = liftM toBool . {#call unsafe layout_iter_at_last_line#}
 
--- @method layoutIterGetBaseline@ Query the vertical position within the
+-- | Query the vertical position within the
 -- layout.
 --
 -- * Gets the y position of the current line's baseline, in layout
@@ -436,7 +434,7 @@
 
 -- pango_layout_iter_get_run goes here
 
--- @method layoutIterGetLine@ Extract the line under the iterator.
+-- | Extract the line under the iterator.
 --
 layoutIterGetLine :: LayoutIter -> IO (Maybe LayoutLine)
 layoutIterGetLine li = do
@@ -444,7 +442,7 @@
   if (llPtr==nullPtr) then return Nothing else 
     liftM Just $ mkLayoutLine llPtr
 
--- @method layoutIterGetCharExtents@ Retrieve a rectangle surrounding
+-- | Retrieve a rectangle surrounding
 -- a character.
 --
 -- * Get the extents of the current character in layout cooridnates
@@ -456,14 +454,14 @@
   {#call unsafe layout_iter_get_char_extents#} li (castPtr logPtr) >>
   peek logPtr
 
--- @method layoutIterGetClusterExtents@ Compute the physical size of the
+-- | Compute the physical size of the
 -- cluster.
 --
 -- * Computes the logical and the ink size of the cluster pointed to by
---   @ref data LayoutIter@.
+--   'LayoutIter'.
 --
 -- * All values are in layoutIter units. To get to device units (pixel for
---   @ref data Drawable@s) divide by @ref constant pangoScale@.
+--   'Drawable's) divide by 'pangoScale'.
 --
 layoutIterGetClusterExtents :: LayoutIter -> IO (Rectangle, Rectangle)
 layoutIterGetClusterExtents li = alloca $ \logPtr -> alloca $ \inkPtr -> do
@@ -473,13 +471,13 @@
   ink <- peek inkPtr
   return (log,ink)
 
--- @method layoutIterGetRunExtents@ Compute the physical size of the run.
+-- | Compute the physical size of the run.
 --
 -- * Computes the logical and the ink size of the run pointed to by
---   @ref data LayoutIter@.
+--   'LayoutIter'.
 --
 -- * All values are in layoutIter units. To get to device units (pixel for
---   @ref data Drawable@s) divide by @ref constant pangoScale@.
+--   'Drawable's) divide by 'pangoScale'.
 --
 layoutIterGetRunExtents :: LayoutIter -> IO (Rectangle, Rectangle)
 layoutIterGetRunExtents li = alloca $ \logPtr -> alloca $ \inkPtr -> do
@@ -489,14 +487,14 @@
   ink <- peek inkPtr
   return (log,ink)
 
--- @method layoutIterGetLineYRange@ Retrieve vertical extent of this
+-- | Retrieve vertical extent of this
 -- line.
 --
--- * Divides the vertical space in the @ref data PangoLayout@ being
+-- * Divides the vertical space in the 'PangoLayout' being
 --   iterated over between the lines in the layout, and returns the
 --   space belonging to the current line. A line's range includes the
 --   line's logical extents, plus half of the spacing above and below
---   the line, if @ref method pangoLayoutSetSpacing@ has been called
+--   the line, if 'pangoLayoutSetSpacing' has been called
 --   to set layout spacing. The y positions are in layout coordinates
 --   (origin at top left of the entire layout).
 --
@@ -510,16 +508,16 @@
   end <- peek ePtr
   return (start,end)
 
--- @method layoutIterGetLineExtents@ Compute the physical size of the line.
+-- | Compute the physical size of the line.
 --
 -- * Computes the logical and the ink size of the line pointed to by
---   @ref data LayoutIter@.
+--   'LayoutIter'.
 --
 -- * Extents are in layout coordinates (origin is the top-left corner
---   of the entire @ref data PangoLayout@). Thus the extents returned
---   by this function will be the same width/height but not at the
---   same x/y as the extents returned from
---   @ref method pangoLayoutLineGetExtents@.
+--   of the entire 'PangoLayout'). Thus the extents returned
+--   by this function will be the same width\/height but not at the
+--   same x\/y as the extents returned from
+--   'pangoLayoutLineGetExtents'.
 --
 layoutIterGetLineExtents :: LayoutIter -> IO (Rectangle, Rectangle)
 layoutIterGetLineExtents li = alloca $ \logPtr -> alloca $ \inkPtr -> do
@@ -530,15 +528,15 @@
   return (log,ink)
 
 
--- @method layoutLineGetExtents@ Compute the physical size of the line.
+-- | Compute the physical size of the line.
 --
--- * Computes the logical and the ink size of the @ref data LayoutLine@. The
+-- * Computes the logical and the ink size of the 'LayoutLine'. The
 --   logical layout is used for positioning, the ink size is the smallest
 --   bounding box that includes all character pixels. The ink size can be
 --   smaller or larger that the logical layout.
 --
 -- * All values are in layout units. To get to device units (pixel for
---   @ref data Drawable@s) divide by @ref constant pangoScale@.
+--   'Drawable's) divide by 'pangoScale'.
 --
 layoutLineGetExtents :: LayoutLine -> IO (Rectangle, Rectangle)
 layoutLineGetExtents pl = alloca $ \logPtr -> alloca $ \inkPtr -> do
@@ -547,15 +545,15 @@
   ink <- peek inkPtr
   return (log,ink)
 
--- @method layoutLineGetPixelExtents@ Compute the physical size of the line.
+-- | Compute the physical size of the line.
 --
--- * Computes the logical and the ink size of the @ref data LayoutLine@. The
+-- * Computes the logical and the ink size of the 'LayoutLine'. The
 --   logical layout is used for positioning, the ink size is the smallest
 --   bounding box that includes all character pixels. The ink size can be
 --   smaller or larger that the logical layout.
 --
 -- * All values are in device units. This function is a wrapper around
---   @ref method layoutLineGetExtents@ with scaling.
+--   'layoutLineGetExtents' with scaling.
 --
 layoutLineGetPixelExtents :: LayoutLine -> IO (Rectangle, Rectangle)
 layoutLineGetPixelExtents pl = alloca $ \logPtr -> alloca $ \inkPtr -> do

Index: Rendering.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/pango/Rendering.chs,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- Rendering.chs	9 Jul 2003 22:42:45 -0000	1.2
+++ Rendering.chs	23 May 2004 16:12:20 -0000	1.3
@@ -1,4 +1,4 @@
---  GIMP Toolkit (GTK) - text layout functions @entry Rendering@
+--  GIMP Toolkit (GTK) - text layout functions Rendering
 --
 --  Author : Axel Simon
 --          
@@ -18,19 +18,14 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * Functions to run the rendering pipeline.
+-- |
 --
--- @documentation@ ------------------------------------------------------------
+-- Functions to run the rendering pipeline.
 --
 -- * The Pango rendering pipeline takes a string of Unicode characters
 --   and converts it into glyphs.  The functions described in this module
 --   accomplish various steps of this process.
 --
--- @todo@ ---------------------------------------------------------------------
---
---
 module Rendering(
   PangoContext
   ) where

[Gtk2hs-commit] gtk2hs ChangeLog,1.165,1.166

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18001

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.165
retrieving revision 1.166
diff -u -d -r1.165 -r1.166
--- ChangeLog	23 May 2004 16:10:58 -0000	1.165
+++ ChangeLog	23 May 2004 16:12:21 -0000	1.166
@@ -70,6 +70,10 @@
 	* gtk/ornaments/Frame.chs, gtk/ornaments/HSeparator.chs,
 	gtk/ornaments/VSeparator.chs: initial haddockification
 
+	* gtk/pango/Markup.hs, gtk/pango/PangoLayout.chs,
+	gtk/pango/PangoTypes.chs, gtk/pango/Rendering.chs:
+	initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs/gtk/ornaments Frame.chs,1.3,1.4 HSeparator.chs,1.3,1.4 VSeparator.chs,1.3,1.4

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

Update of /cvsroot/gtk2hs/gtk2hs/gtk/ornaments
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17652/gtk/ornaments

Modified Files:
	Frame.chs HSeparator.chs VSeparator.chs 
Log Message:
initial haddockification


Index: Frame.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/ornaments/Frame.chs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- Frame.chs	9 Jul 2003 22:42:45 -0000	1.3
+++ Frame.chs	23 May 2004 16:10:57 -0000	1.4
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget Frame@
+--  GIMP Toolkit (GTK) Widget Frame
 --
 --  Author : Axel Simon
 --          
@@ -19,15 +19,11 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * This container adds a frame around its contents. This is useful to
---   logically separate items in a dialog box.
---
--- @documentation@ ------------------------------------------------------------
+-- |
 --
+-- This container adds a frame around its contents. This is useful to
+-- logically separate items in a dialog box.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module Frame(
   Frame,
@@ -54,27 +50,27 @@
 
 -- methods
 
--- @constructor frameNew@ Create a new frame without a label.
+-- | Create a new frame without a label.
 --
--- * A label can later be set by calling @ref method frameSetLabel@.
+-- * A label can later be set by calling 'frameSetLabel'.
 --
 frameNew :: IO Frame
 frameNew  = makeNewObject mkFrame $
   liftM castPtr $ {#call unsafe frame_new#} nullPtr
 
--- @method frameSetLabel@ Replace the label of the frame.
+-- | Replace the label of the frame.
 --
 frameSetLabel :: FrameClass f => f -> String -> IO ()
 frameSetLabel f label = withUTFString label $ \strPtr ->
   {#call frame_set_label#} (toFrame f) strPtr
 
--- @method frameSetLabelWidget@ Replace the label with a (label) widget.
+-- | Replace the label with a (label) widget.
 --
 frameSetLabelWidget :: (FrameClass f, WidgetClass w) => f -> w -> IO ()
 frameSetLabelWidget f w = 
   {#call frame_set_label_widget#} (toFrame f) (toWidget w)
 
--- @method frameSetLabelAlign@ Specify where the label should be placed.
+-- | Specify where the label should be placed.
 --
 -- * A value of 0.0 means left justified (the default), a value of 1.0 means
 --   right justified.
@@ -83,15 +79,15 @@
 frameSetLabelAlign f align =
   {#call frame_set_label_align#} (toFrame f) (realToFrac align) 0.0
 
--- @method frameSetShadowType@ Set the shadow type of the frame.
+-- | Set the shadow type of the frame.
 --
 frameSetShadowType :: FrameClass f => f -> ShadowType -> IO ()
 frameSetShadowType f shadow = 
   {#call frame_set_shadow_type#} (toFrame f) ((fromIntegral.fromEnum) shadow)
 
--- @method frameGetLabel@ Retrieve the label of the frame.
+-- | Retrieve the label of the frame.
 --
--- * An exception is thrown if a non-Label widget was set. (EXPORTED)
+-- * An exception is thrown if a non-Label widget was set.
 --
 frameGetLabel :: FrameClass f => f -> IO String
 frameGetLabel f = do

Index: HSeparator.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/ornaments/HSeparator.chs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- HSeparator.chs	9 Jul 2003 22:42:45 -0000	1.3
+++ HSeparator.chs	23 May 2004 16:10:57 -0000	1.4
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget HSeparator@
+--  GIMP Toolkit (GTK) Widget HSeparator
 --
 --  Author : Axel Simon
 --          
@@ -19,18 +19,14 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @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.
+-- 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.
 --
--- @documentation@ ------------------------------------------------------------
---
---
--- @todo@ ---------------------------------------------------------------------
 
 module HSeparator(
   HSeparator,

Index: VSeparator.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/ornaments/VSeparator.chs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- VSeparator.chs	9 Jul 2003 22:42:45 -0000	1.3
+++ VSeparator.chs	23 May 2004 16:10:57 -0000	1.4
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget VSeparator@
+--  GIMP Toolkit (GTK) Widget VSeparator
 --
 --  Author : Axel Simon
 --          
@@ -19,18 +19,14 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
+-- |
 --
--- * 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.
+-- 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.
 --
--- @documentation@ ------------------------------------------------------------
---
---
--- @todo@ ---------------------------------------------------------------------
 
 module VSeparator(
   VSeparator,

[Gtk2hs-commit] gtk2hs ChangeLog,1.164,1.165

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17652

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.164
retrieving revision 1.165
diff -u -d -r1.164 -r1.165
--- ChangeLog	23 May 2004 16:09:08 -0000	1.164
+++ ChangeLog	23 May 2004 16:10:58 -0000	1.165
@@ -67,6 +67,9 @@
 	gtk/multiline/TextTagTable.chs, gtk/multiline/TextView.chs:
 	initial haddockification
 
+	* gtk/ornaments/Frame.chs, gtk/ornaments/HSeparator.chs,
+	gtk/ornaments/VSeparator.chs: initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs ChangeLog,1.163,1.164

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17300

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.163
retrieving revision 1.164
diff -u -d -r1.163 -r1.164
--- ChangeLog	23 May 2004 16:07:53 -0000	1.163
+++ ChangeLog	23 May 2004 16:09:08 -0000	1.164
@@ -62,6 +62,11 @@
 	gtk/misc/HandleBox.chs, gtk/misc/Tooltips.chs,
 	gtk/misc/Viewport.chs: initial haddockification
 
+	* gtk/multiline/TextBuffer.chs, gtk/multiline/TextIter.chs
+	gtk/multiline/TextMark.chs, gtk/multiline/TextTag.chs,
+	gtk/multiline/TextTagTable.chs, gtk/multiline/TextView.chs:
+	initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs/gtk/misc Adjustment.chs,1.3,1.4 Calendar.chs,1.3,1.4 DrawingArea.chs,1.4,1.5 EventBox.chs,1.4,1.5 FileChooserWidget.chs,1.1,1.2 GArrow.chs,1.1,1.2 HandleBox.chs,1.6,1.7 Tooltips.chs,1.5,1.6 Viewport.chs,1.5,1.6

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

Update of /cvsroot/gtk2hs/gtk2hs/gtk/misc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17017/gtk/misc

Modified Files:
	Adjustment.chs Calendar.chs DrawingArea.chs EventBox.chs 
	FileChooserWidget.chs GArrow.chs HandleBox.chs Tooltips.chs 
	Viewport.chs 
Log Message:
initial haddockification


Index: DrawingArea.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/misc/DrawingArea.chs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- DrawingArea.chs	9 Jul 2003 22:42:45 -0000	1.4
+++ DrawingArea.chs	23 May 2004 16:07:53 -0000	1.5
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget DrawingArea@
+--  GIMP Toolkit (GTK) Widget DrawingArea
 --
 --  Author : Axel Simon
 --          
@@ -19,24 +19,20 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * A user-defined widget.
+-- |
 --
--- @documentation@ ------------------------------------------------------------
+-- A user-defined widget.
 --
--- * The @ref data DrawingArea@ widget is used for creating custom
+-- * The 'DrawingArea' widget is used for creating custom
 --   user interface elements. It's essentially a blank widget. Drawing on
---   the @ref type Drawable@ returned by @ref method drawingAreaGetWindow@
---   has to be done each time the window manager sends @ref signal expose@
+--   the 'Drawable' returned by 'drawingAreaGetWindow'
+--   has to be done each time the window manager sends @\"expose\"@
 --   events. Note that the library automatically clears the exposed area to
 --   the background color before sending the expose event, and that drawing
 --   is implicitly clipped to the exposed area. Other events which are
 --   interesting for interacting are mouse and butten events defined in
---   @ref data Widget@. If the widget changes in size (which it does
---   initially), a @ref signal configure@ event is emitted.
---
--- @todo@ ---------------------------------------------------------------------
+--   'Widget'. If the widget changes in size (which it does
+--   initially), a @\"configure\"@ event is emitted.
 --
 module DrawingArea(
   DrawingArea,
@@ -58,7 +54,7 @@
 
 -- methods
 
--- @constructor drawingAreaNew@ Create a new custom widget.
+-- | Create a new custom widget.
 --
 drawingAreaNew :: IO DrawingArea
 drawingAreaNew = makeNewObject mkDrawingArea $ 

Index: HandleBox.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/misc/HandleBox.chs,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- HandleBox.chs	9 Jul 2003 22:42:45 -0000	1.6
+++ HandleBox.chs	23 May 2004 16:07:53 -0000	1.7
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget HandleBox@
+--  GIMP Toolkit (GTK) Widget HandleBox
 --
 --  Author : Axel Simon
 --          
@@ -19,14 +19,12 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * Add a handle to some other widget so that it can be detached and 
---   reattached from the main application.
+-- |
 --
--- @documentation@ ------------------------------------------------------------
+-- Add a handle to some other widget so that it can be detached and 
+-- reattached from the main application.
 --
--- * The GtkHandleBox widget allows a portion of a window to be "torn off". It
+-- * The GtkHandleBox widget allows a portion of a window to be \"torn off\". It
 --   is a bin widget which displays its child and a handle that the user can 
 --   drag to tear off a separate window (the float window) containing the 
 --   child widget. A thin ghost is drawn in the original location of the 
@@ -39,13 +37,12 @@
 --   To make detaching and reattaching the handlebox as minimally confusing 
 --   as possible to the user, it is important to set the snap edge so that 
 --   the snap edge does not move when the handlebox is deattached. For 
---   instance, if the handlebox is packed at the bottom of a @ref data VBox@,
+--   instance, if the handlebox is packed at the bottom of a 'VBox',
 --   then when 
 --   the handlebox is detached, the bottom edge of the handlebox's allocation 
 --   will remain fixed as the height of the handlebox shrinks, so the snap 
---   edge should be set to @ref data PosBottom@.
+--   edge should be set to 'PosBottom'.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module HandleBox(
   HandleBox,
@@ -75,34 +72,34 @@
 
 -- methods
 
--- @constructor handleBoxNew@ Create a new handle box.
+-- | Create a new handle box.
 --
 handleBoxNew :: IO HandleBox
 handleBoxNew  = makeNewObject mkHandleBox $ 
   liftM castPtr {#call unsafe handle_box_new#}
 
--- @method handleBoxSetShadowType@ Set the shadow type of the detached box.
+-- | Set the shadow type of the detached box.
 --
 handleBoxSetShadowType :: HandleBoxClass hb => hb -> ShadowType -> IO ()
 handleBoxSetShadowType hb shadow = {#call handle_box_set_shadow_type#}
   (toHandleBox hb) ((fromIntegral.fromEnum) shadow)
 
--- @method handleBoxSetHandlePosition@ Set the position of the handle.
+-- | Set the position of the handle.
 --
 handleBoxSetHandlePosition :: HandleBoxClass hb => hb -> PositionType -> IO ()
 handleBoxSetHandlePosition hb pos = {#call handle_box_set_handle_position#} 
   (toHandleBox hb) ((fromIntegral.fromEnum) pos)
 
--- @method handleBoxSetSnapEdge@ Set the snap edge of the HandleBox.
+-- | Set the snap edge of the HandleBox.
 --
 -- * The snap edge is the edge of the detached child that must be aligned with
---   the corresponding edge of the "ghost" left behind when the child was
+--   the corresponding edge of the \"ghost\" left behind when the child was
 --   detached to reattach the torn-off window. Usually, the snap edge should
 --   be chosen so that it stays in the same place on the screen when the
 --   handlebox is torn off. If the snap edge is not set, then an appropriate
 --   value will be guessed from the handle position. If the handle position is
---   @ref variant PosRight@ or @ref variant PosLeft@, then the snap edge will
---   be @ref variant PosTop@, otherwise it will be @ref variant PosLeft@.
+--   'PosRight' or 'PosLeft', then the snap edge will
+--   be 'PosTop', otherwise it will be 'PosLeft'.
 --
 handleBoxSetSnapEdge :: HandleBoxClass hb => hb -> PositionType -> IO ()
 handleBoxSetSnapEdge hb pos = {#call handle_box_set_snap_edge#}
@@ -110,7 +107,7 @@
 
 -- signals
 
--- @signal connectToChildAttached@ Emitted when the contents of the handlebox
+-- | Emitted when the contents of the handlebox
 -- are reattached to the main window.
 --
 -- * (INTERNAL) We ignore the given Widget.
@@ -121,7 +118,7 @@
 afterChildAttached = connect_NONE__NONE "child-attached" True
 
 
--- @signal connectToChildDetached@ Emitted when the @ref data HandleBox@ is
+-- | Emitted when the 'HandleBox' is
 -- detached form the main window.
 --
 onChildDetached, afterChildDetached :: HandleBoxClass hb => hb -> IO () ->

Index: Calendar.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/misc/Calendar.chs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- Calendar.chs	9 Jul 2003 22:42:45 -0000	1.3
+++ Calendar.chs	23 May 2004 16:07:53 -0000	1.4
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget Calendar@
+--  GIMP Toolkit (GTK) Widget Calendar
 --
 --  Author : Axel Simon
 --          
@@ -19,14 +19,10 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * This widget shows a calendar.
---
--- @documentation@ ------------------------------------------------------------
+-- |
 --
+-- This widget shows a calendar.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module Calendar(
   Calendar,
@@ -68,7 +64,7 @@
 
 -- methods
 
--- @constructor calendarNew@ Create a new calendar widget.
+-- | Create a new calendar widget.
 --
 -- * No sensible date will be set.
 --
@@ -76,7 +72,7 @@
 calendarNew  = makeNewObject mkCalendar $ 
   liftM castPtr {#call unsafe calendar_new#}
 
--- @method calendarSelectMonth@ Flip the page to a month , 0 is January,.., 11
+-- | Flip the page to a month , 0 is January,.., 11
 -- is December.
 --
 -- * Returns True if the operation succeeded.
@@ -86,14 +82,14 @@
   {#call calendar_select_month#} (toCalendar cal) (fromIntegral month)
   (fromIntegral year)
 
--- @method calendarSelectDay@ Shift to a day, counted form 1 to 31 (depending
+-- | Shift to a day, counted form 1 to 31 (depending
 -- on the month of course).
 --
 calendarSelectDay :: CalendarClass c => c -> Int -> IO ()
 calendarSelectDay cal day = 
   {#call calendar_select_day#} (toCalendar cal) (fromIntegral day)
 
--- @method calendarMarkDay@ Mark (select) a day in the current month.
+-- | Mark (select) a day in the current month.
 --
 -- * Returns True if the argument was within bounds and the day was previously
 --   deselected.
@@ -102,7 +98,7 @@
 calendarMarkDay cal day = liftM toBool $
   {#call calendar_mark_day#} (toCalendar cal) (fromIntegral day)
 
--- @method calendarUnmarkDay@ Unmark (deselect) a day in the current month.
+-- | Unmark (deselect) a day in the current month.
 --
 -- * Returns True if the argument was within bounds and the day was previously
 --   selected.
@@ -111,12 +107,12 @@
 calendarUnmarkDay cal day = liftM toBool $
   {#call calendar_unmark_day#} (toCalendar cal) (fromIntegral day)
 
--- @method calendarClearMarks@ Unmark every day in the current page.
+-- | Unmark every day in the current page.
 --
 calendarClearMarks :: CalendarClass c => c -> IO ()
 calendarClearMarks cal = {#call calendar_clear_marks#} (toCalendar cal)
 
--- @method calendarDisplayOptions@ Specifies how the calendar should be
+-- | Specifies how the calendar should be
 -- displayed.
 --
 calendarDisplayOptions :: CalendarClass c => c -> [CalendarDisplayOptions] ->
@@ -124,7 +120,7 @@
 calendarDisplayOptions cal opts = {#call calendar_display_options#}
   (toCalendar cal) ((fromIntegral.fromFlags) opts)
 
--- @method calendarGetDate@ Retrieve the currently selected date.
+-- | Retrieve the currently selected date.
 --
 -- * Returns (year, month, day) of the selection.
 --
@@ -137,7 +133,7 @@
     day	  <- liftM fromIntegral	$ peek dayPtr
     return (year,month,day)
 
--- @method calendarFreeze@ Freeze the calender for several update operations.
+-- | Freeze the calender for several update operations.
 --
 calendarFreeze :: CalendarClass c => c -> IO a -> IO a
 calendarFreeze cal update = do
@@ -148,14 +144,14 @@
 
 -- signals
 
--- @signal connectToDaySelected@ Emitted when a day was selected.
+-- | Emitted when a day was selected.
 --
 onDaySelected, afterDaySelected :: CalendarClass c => c -> IO () ->
                                    IO (ConnectId c)
 onDaySelected = connect_NONE__NONE "day-selected" False
 afterDaySelected = connect_NONE__NONE "day-selected" True
 
--- @signal connectToDaySelectedDoubleClick@ Emitted when a day received a
+-- | Emitted when a day received a
 -- double click.
 --
 onDaySelectedDoubleClick, afterDaySelectedDoubleClick :: CalendarClass c => 
@@ -166,34 +162,34 @@
 afterDaySelectedDoubleClick = 
   connect_NONE__NONE "day-selected-double-click" True
 
--- @signal connectToMonthChanged@ The month changed.
+-- | The month changed.
 --
 onMonthChanged, afterMonthChanged :: CalendarClass c => c -> IO () ->
                                      IO (ConnectId c)
 onMonthChanged = connect_NONE__NONE "month-changed" False
 afterMonthChanged = connect_NONE__NONE "month-changed" True
 
--- @signal connectToNextMonth@ The next month was selected.
+-- | The next month was selected.
 --
 onNextMonth, afterNextMonth :: CalendarClass c => c -> IO () ->
                                IO (ConnectId c)
 onNextMonth = connect_NONE__NONE "next-month" False
 afterNextMonth = connect_NONE__NONE "next-month" True
 
--- @signal connectToNextYear@ The next year was selected.
+-- | The next year was selected.
 --
 onNextYear, afterNextYear :: CalendarClass c => c -> IO () -> IO (ConnectId c)
 onNextYear = connect_NONE__NONE "next-year" False
 afterNextYear = connect_NONE__NONE "next-year" True
 
--- @signal connectToPrevMonth@ The previous month was selected.
+-- | The previous month was selected.
 --
 onPrevMonth, afterPrevMonth :: CalendarClass c => c -> IO () ->
                                IO (ConnectId c)
 onPrevMonth = connect_NONE__NONE "prev-month" False
 afterPrevMonth = connect_NONE__NONE "prev-month" True
 
--- @signal connectToPrevYear@ The previous year was selected.
+-- | The previous year was selected.
 --
 onPrevYear, afterPrevYear :: CalendarClass c => c -> IO () -> IO (ConnectId c)
 onPrevYear = connect_NONE__NONE "prev-year" False

Index: Tooltips.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/misc/Tooltips.chs,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- Tooltips.chs	9 Jul 2003 22:42:45 -0000	1.5
+++ Tooltips.chs	23 May 2004 16:07:53 -0000	1.6
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget Tooltips@
+--  GIMP Toolkit (GTK) Widget Tooltips
 --
 --  Author : Axel Simon
 --          
@@ -19,32 +19,29 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
+-- |
 --
 -- * Tooltips are the messages that appear next to a widget when the mouse
 --   pointer is held over it for a short amount of time. They are especially
 --   helpful for adding more verbose descriptions of things such as buttons
 --   in a toolbar. 
 --   An individual tooltip belongs to a group of tooltips. A group is created
---   with a call to @ref method tooltipsNew@. Every tooltip in the group can 
+--   with a call to 'tooltipsNew'. Every tooltip in the group can 
 --   then be 
---   turned off with a call to @ref method tooltipsDisable@ and enabled with 
---   @ref method tooltipsEnable@. The length of time the user must keep the
+--   turned off with a call to 'tooltipsDisable' and enabled with 
+--   'tooltipsEnable'. The length of time the user must keep the
 --   mouse over a 
 --   widget before the tip is shown, can be altered with 
---   @ref method tooltipsSetDelay@.
+--   'tooltipsSetDelay'.
 --   This is set on a 'per group of tooltips' basis.
---   To assign a tip to a particular widget, @ref method tooltipsSetTip@
+--   To assign a tip to a particular widget, 'tooltipsSetTip'
 --   is used.
 --
--- @documentation@ ------------------------------------------------------------
---
--- * To associate @ref data Tooltips@ to a widget it is has to have its own 
---   @ref data DrawWindow@. Otherwise the widget must be set into an
---   @ref data EventBox@. Can this be done
+-- * To associate 'Tooltips' to a widget it is has to have its own 
+--   'DrawWindow'. Otherwise the widget must be set into an
+--   'EventBox'. Can this be done
 --   automatically? Perhaps even with tooltips_force_window()?
 --
--- @todo@ ---------------------------------------------------------------------
 
 module Tooltips(
   Tooltips,
@@ -68,40 +65,40 @@
 
 -- methods
 
--- @constructor tooltipsNew@ Create a new goup of @ref type Tooltips@.
+-- | Create a new goup of 'Tooltips'.
 --
 tooltipsNew :: IO Tooltips
 tooltipsNew  = makeNewObject mkTooltips $ 
   liftM castPtr {#call unsafe tooltips_new#}
 
--- @method tooltipsEnable@ Display the help the @ref type Tooltips@ group
+-- | Display the help the 'Tooltips' group
 -- provides.
 --
 tooltipsEnable :: TooltipsClass t => t -> IO ()
 tooltipsEnable t = {#call unsafe tooltips_enable#} (toTooltips t)
 
--- @method tooltipsDisable@ Disable @ref type Tooltips@ group.
+-- | Disable 'Tooltips' group.
 --
 -- * Causes all tooltips in tooltips to become inactive. Any widgets that have
 --   tips associated with that group will no longer display their tips until
---   they are enabled again with @ref method tooltipsEnable@.
+--   they are enabled again with 'tooltipsEnable'.
 --
 tooltipsDisable :: TooltipsClass t => t -> IO ()
 tooltipsDisable t = {#call unsafe tooltips_disable#} (toTooltips t)
 
--- @method tooltipsSetDelay@ Sets the time between the user moving the mouse
+-- | Sets the time between the user moving the mouse
 -- over a widget and the widget's tooltip appearing.
 --
--- * The @ref arg time@ parameter is in ms.
+-- * The @time@ parameter is in ms.
 --
 tooltipsSetDelay :: TooltipsClass t => t -> Int -> IO ()
 tooltipsSetDelay t time = {#call unsafe tooltips_set_delay#}
   (toTooltips t) (fromIntegral time)
 
--- @method tooltipsSetTip@ Adds a tooltip containing the message tipText to
+-- | Adds a tooltip containing the message tipText to
 -- the specified GtkWidget.
 --
--- * The @ref arg tipPrivate@ parameter is meant to give a thorough
+-- * The @tipPrivate@ parameter is meant to give a thorough
 --   explaination. This might someday be accessible to a questionmark cursor
 --   (like MS Windows).
 --

Index: Adjustment.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/misc/Adjustment.chs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- Adjustment.chs	9 Jul 2003 22:42:44 -0000	1.3
+++ Adjustment.chs	23 May 2004 16:07:53 -0000	1.4
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget Adjustment@
+--  GIMP Toolkit (GTK) Widget Adjustment
 --
 --  Author : Axel Simon
 --          
@@ -19,15 +19,11 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * An Adjustment object contains a value with maximum bounds and a step size.
---   It is used to represent the value of a scoll bar and similar widgets.
---
--- @documentation@ ------------------------------------------------------------
+-- |
 --
+-- An Adjustment object contains a value with maximum bounds and a step size.
+-- It is used to represent the value of a scoll bar and similar widgets.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module Adjustment(
   Adjustment,
@@ -53,13 +49,13 @@
 
 -- methods
 
--- @constructor adjustmentNew@ Create a new Adjustment object.
+-- | Create a new Adjustment object.
 --
 -- * The creation function take every value that is contained in the object:
---   @ref arg value@ is the initial value and should be between the
---   @ref arg upper@ and @ref arg lower@ bounds of the slider. Clicking on the
---   arrows increases this value by @ref arg stepIncrement@. Clicking in the
---   slider advances by @ref arg pageIncrement@. The @ref arg pageSize@ is
+--   @value@ is the initial value and should be between the
+--   @upper@ and @lower@ bounds of the slider. Clicking on the
+--   arrows increases this value by @stepIncrement@. Clicking in the
+--   slider advances by @pageIncrement@. The @pageSize@ is
 --   needed to determine if the end of the slider is still in the range.
 --
 adjustmentNew :: Double -> Double -> Double -> Double -> Double -> Double ->
@@ -70,19 +66,19 @@
   (realToFrac stepIncrement) (realToFrac pageIncrement) 
   (realToFrac pageSize)
 
--- @method adjustmentSetValue@ Set the current value of the Adjustment object.
+-- | Set the current value of the Adjustment object.
 --
 adjustmentSetValue :: Adjustment -> Double -> IO ()
 adjustmentSetValue a value = 
   {#call adjustment_set_value#} (toAdjustment a) (realToFrac value)
 
--- @method adjustmentClampPage@ Ensure that the alignment is within these
+-- | Ensure that the alignment is within these
 -- bounds.
 --
 -- * Updates the Adjustment value to ensure that the range between lower and
 --   upper is in the current page (i.e. between value and value + page_size).
 --   If the range is larger than the page size, then only the start of it will
---   be in the current page. A "changed" signal will be emitted if the value
+--   be in the current page. A \"changed\" signal will be emitted if the value
 --   is changed.
 --
 adjustmentClampPage :: Adjustment -> Double -> Double -> IO ()
@@ -91,15 +87,15 @@
 
 -- signals
 
--- @signal connectToAdjChanged@ This signal is emitted if some value of
--- Adjustment except @ref arg value@ itself changes.
+-- | This signal is emitted if some value of
+-- Adjustment except @value@ itself changes.
 --
 onAdjChanged, afterAdjChanged :: Adjustment -> IO () ->
                                  IO (ConnectId Adjustment)
 onAdjChanged = connect_NONE__NONE "changed" False
 afterAdjChanged = connect_NONE__NONE "changed" True
 
--- @signal connectToValueChanged@ This signal is emitted if the value of the
+-- | This signal is emitted if the value of the
 -- Alignment object changed.
 --
 onValueChanged, afterValueChanged :: Adjustment -> IO () ->

Index: Viewport.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/misc/Viewport.chs,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- Viewport.chs	9 Jul 2003 22:42:45 -0000	1.5
+++ Viewport.chs	23 May 2004 16:07:53 -0000	1.6
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget Viewport@
+--  GIMP Toolkit (GTK) Widget Viewport
 --
 --  Author : Axel Simon
 --          
@@ -19,24 +19,18 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * A @ref data Viewport@ a helper widget that adds Adjustment slots to a 
---   widget, i.e.
---   the widget becomes scrollable. It can then be put into 
---   @ref data ScrolledWindow@
---   and will behave as expected.
+-- |
 --
--- @documentation@ ------------------------------------------------------------
+-- A 'Viewport' a helper widget that adds Adjustment slots to a 
+-- widget, i.e. the widget becomes scrollable. It can then be put into 
+-- 'ScrolledWindow' and will behave as expected.
 --
 -- * The binding of this widget is superfluous as far as I can tell.
 --
--- * The only signal this widget registers is "set-scroll-adjustments". It is
---   not bound because it is meant to be received by the @ref data Viewport@
---    and sent
---   by @ref data ScrolledWindow@.
+-- * The only signal this widget registers is \"set-scroll-adjustments\". It is
+--   not bound because it is meant to be received by the 'Viewport'
+--   and sent by 'ScrolledWindow'.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module Viewport(
   Viewport,
@@ -63,41 +57,41 @@
 
 -- methods
 
--- @constructor viewportNew@ Create a new @ref type Viewport@.
+-- | Create a new 'Viewport'.
 --
 viewportNew :: Adjustment -> Adjustment -> IO Viewport
 viewportNew vAdj hAdj = makeNewObject mkViewport $ liftM castPtr $
   {#call unsafe viewport_new#} hAdj vAdj
 
--- @method viewportGetHAdjustment@ Retrieve the horizontal
--- @ref data Adjustment@ of the @ref type Viewport@.
+-- | Retrieve the horizontal
+-- 'Adjustment' of the 'Viewport'.
 --
 viewportGetHAdjustment :: ViewportClass v => v -> IO Adjustment
 viewportGetHAdjustment v = makeNewObject mkAdjustment $
   {#call unsafe viewport_get_hadjustment#} (toViewport v)
 
--- @method viewportGetVAdjustment@ Retrieve the vertical @ref data Adjustment@
--- of the @ref type Viewport@.
+-- | Retrieve the vertical 'Adjustment'
+-- of the 'Viewport'.
 --
 viewportGetVAdjustment :: ViewportClass v => v -> IO Adjustment
 viewportGetVAdjustment v = makeNewObject mkAdjustment $
   {#call unsafe viewport_get_vadjustment#} (toViewport v)
 
--- @method viewportSetHAdjustment@ Set the horizontal @ref data Adjustment@ of
--- the @ref type Viewport@.
+-- | Set the horizontal 'Adjustment' of
+-- the 'Viewport'.
 --
 viewportSetHAdjustment :: ViewportClass v => v -> Adjustment -> IO ()
 viewportSetHAdjustment v adj = {#call viewport_set_hadjustment#}
   (toViewport v) adj
 
--- @method viewportSetVAdjustment@ Set the vertical @ref data Adjustment@ of
--- the @ref type Viewport@.
+-- | Set the vertical 'Adjustment' of
+-- the 'Viewport'.
 --
 viewportSetVAdjustment :: ViewportClass v => v -> Adjustment -> IO ()
 viewportSetVAdjustment v adj = {#call viewport_set_hadjustment#}
   (toViewport v) adj
 
--- @method viewportSetShadowType@ Specify if and how an outer frame should be
+-- | Specify if and how an outer frame should be
 -- drawn around the child.
 --
 viewportSetShadowType :: ViewportClass v => v -> ShadowType -> IO ()

Index: EventBox.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/misc/EventBox.chs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- EventBox.chs	9 Jul 2003 22:42:45 -0000	1.4
+++ EventBox.chs	23 May 2004 16:07:53 -0000	1.5
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget EventBox@
+--  GIMP Toolkit (GTK) Widget EventBox
 --
 --  Author : Axel Simon
 --          
@@ -19,15 +19,12 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * This container can be used to receive @ref data Event@s for a widget
---   that has no window on its own.
---
--- @documentation@ ------------------------------------------------------------
+-- |
 --
+-- This container can be used to receive 'Event's for a widget
+-- that has no window on its own.
 --
--- @todo@ ---------------------------------------------------------------------
+-- TODO
 --
 -- * check: Is this widget useful?
 --
@@ -49,7 +46,7 @@
 
 -- methods
 
--- @constructor eventBoxNew@ Create a new @ref type EventBox@.
+-- | Create a new 'EventBox'.
 --
 eventBoxNew :: IO EventBox
 eventBoxNew  = makeNewObject mkEventBox $ 

Index: GArrow.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/misc/GArrow.chs,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- GArrow.chs	13 Jul 2003 11:34:52 -0000	1.1
+++ GArrow.chs	23 May 2004 16:07:53 -0000	1.2
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget GArrow@
+--  GIMP Toolkit (GTK) Widget GArrow
 --
 --  Author : Axel Simon
 --          
@@ -19,14 +19,10 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * An Arrow pointing to one of the four cardinal direction.
---
--- @documentation@ ------------------------------------------------------------
+-- |
 --
+-- An Arrow pointing to one of the four cardinal direction.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module GArrow(
   Arrow,
@@ -50,14 +46,14 @@
 
 -- methods
 
--- @constructor arrowNew@ Create a new arrow with display options.
+-- | Create a new arrow with display options.
 --
 arrowNew :: ArrowType -> ShadowType -> IO Arrow
 arrowNew at st = makeNewObject mkArrow $ liftM castPtr $ 
   {#call unsafe arrow_new#} ((fromIntegral.fromEnum) at) 
   ((fromIntegral.fromEnum) st)
 
--- @method arrowSet@ Change the visual appearance of this widget.
+-- | Change the visual appearance of this widget.
 --
 arrowSet :: ArrowClass a => a -> ArrowType -> ShadowType -> IO ()
 arrowSet a at st = {#call arrow_set#} (toArrow a) ((fromIntegral.fromEnum) at)

Index: FileChooserWidget.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/misc/FileChooserWidget.chs,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- FileChooserWidget.chs	30 Apr 2004 20:52:41 -0000	1.1
+++ FileChooserWidget.chs	23 May 2004 16:07:53 -0000	1.2
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
--- |GIMP Toolkit (GTK) @entry Widget FileChooserWidget@
+--  GIMP Toolkit (GTK) entry Widget FileChooserWidget
 --
 --  Author : Duncan Coutts
 --  Created: 24 April 2004
@@ -16,15 +16,15 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 --  Library General Public License for more details.
 --
---- Description ---------------------------------------------------------------
+-- |
 --
---  Language: Haskell 98 Binding Module
+--  The file chooser dialog and widget is a replacement
+--  for the old "FileSel"ection dialog. It provides a better user
+--  interface and an improved API.
 --
---  The file chooser dialog & widget is a replacement (introduced with gtk+ 2.4)
---  for the old and ugly GtkFileSelection dialog. It provides a better user
---  interface and an improved API
+-- * This is the widget variant of the "FileChooser"
 --
---  This is the widget variant of the FileChooser
+-- * Added in GTK+ 2.4
 --
 
 module FileChooserWidget (

[Gtk2hs-commit] gtk2hs ChangeLog,1.162,1.163

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17017

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.162
retrieving revision 1.163
diff -u -d -r1.162 -r1.163
--- ChangeLog	23 May 2004 16:05:22 -0000	1.162
+++ ChangeLog	23 May 2004 16:07:53 -0000	1.163
@@ -56,6 +56,12 @@
 	gtk/menuComboToolbar/TearoffMenuItem.chs,
 	gtk/menuComboToolbar/Toolbar.chs: initial haddockification
 
+	* gtk/misc/Adjustment.chs, gtk/misc/Calendar.chs,
+	gtk/misc/DrawingArea.chs, gtk/misc/EventBox.chs,
+	gtk/misc/FileChooserWidget.chs, gtk/misc/GArrow.chs,
+	gtk/misc/HandleBox.chs, gtk/misc/Tooltips.chs,
+	gtk/misc/Viewport.chs: initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs ChangeLog,1.161,1.162

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16309

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.161
retrieving revision 1.162
diff -u -d -r1.161 -r1.162
--- ChangeLog	23 May 2004 16:02:58 -0000	1.161
+++ ChangeLog	23 May 2004 16:05:22 -0000	1.162
@@ -44,6 +44,18 @@
 	gtk/layout/VButtonBox.chs, gtk/layout/VPaned.chs:
 	initial haddockification
 
+	* gtk/menuComboToolbar/CheckMenuItem.chs,
+	gtk/menuComboToolbar/Combo.chs, gtk/menuComboToolbar/ComboBox.chs,
+	gtk/menuComboToolbar/ComboBoxEntry.chs,
+	gtk/menuComboToolbar/ImageMenuItem.chs,
+	gtk/menuComboToolbar/Menu.chs, gtk/menuComboToolbar/MenuBar.chs,
+	gtk/menuComboToolbar/MenuItem.chs,
+	gtk/menuComboToolbar/MenuShell.chs,
+	gtk/menuComboToolbar/OptionMenu.chs,
+	gtk/menuComboToolbar/RadioMenuItem.chs,
+	gtk/menuComboToolbar/TearoffMenuItem.chs,
+	gtk/menuComboToolbar/Toolbar.chs: initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs ChangeLog,1.160,1.161

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv15728

Modified Files:
	ChangeLog 
Log Message:
initial haddockificatio


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.160
retrieving revision 1.161
diff -u -d -r1.160 -r1.161
--- ChangeLog	23 May 2004 16:00:53 -0000	1.160
+++ ChangeLog	23 May 2004 16:02:58 -0000	1.161
@@ -36,6 +36,14 @@
 	gtk/glib/GValue.chs, gtk/glib/GValueTypes.chs:
 	initial haddockification
 
+	* gtk/layout/Alignment.chs, gtk/layout/AspectFrame.chs,
+	gtk/layout/Expander.chs, gtk/layout/HBox.chs,
+	gtk/layout/HButtonBox.chs, gtk/layout/HPaned.chs,
+	gtk/layout/Layout.chs, gtk/layout/Notebook.chs,
+	gtk/layout/Table.chs, gtk/layout/VBox.chs,
+	gtk/layout/VButtonBox.chs, gtk/layout/VPaned.chs:
+	initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs/gtk/glib GList.chs,1.8,1.9 GObject.chs,1.7,1.8 GType.chs,1.4,1.5 GValue.chs,1.5,1.6 GValueTypes.chs,1.5,1.6

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

Update of /cvsroot/gtk2hs/gtk2hs/gtk/glib
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv15413/gtk/glib

Modified Files:
	GList.chs GObject.chs GType.chs GValue.chs GValueTypes.chs 
Log Message:
initial haddockification


Index: GValueTypes.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/glib/GValueTypes.chs,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- GValueTypes.chs	9 Jul 2003 22:42:44 -0000	1.5
+++ GValueTypes.chs	23 May 2004 16:00:53 -0000	1.6
@@ -19,15 +19,13 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
+-- |
 --
 -- * This module implements only the necessities for the GTK binding.
 --
--- @documentation@ ------------------------------------------------------------
---
--- * Everything here is only used by @ref data TreeStore@ and friends.
+-- * Everything here is only used by 'TreeStore' and friends.
 --
--- @todo@ ---------------------------------------------------------------------
+-- TODO
 --
 -- * Replace POINTER with Stable Dynamic or something safe and Haskell like.
 --

Index: GType.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/glib/GType.chs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- GType.chs	9 Jul 2003 22:42:44 -0000	1.4
+++ GType.chs	23 May 2004 16:00:53 -0000	1.5
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry GType@
+--  GIMP Toolkit (GTK) GType
 --
 --  Author : Axel Simon
 --          
@@ -19,15 +19,10 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
+-- |
 --
 -- * This module implements only the necessities for the GTK binding.
 --
--- @documentation@ ------------------------------------------------------------
---
---
--- @todo@ ---------------------------------------------------------------------
---
 module GType(
   GType,
   typeInstanceIsA

Index: GList.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/glib/GList.chs,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- GList.chs	2 Nov 2003 23:57:07 -0000	1.8
+++ GList.chs	23 May 2004 16:00:51 -0000	1.9
@@ -17,19 +17,13 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
+-- |
 --
--- * Defines functions to extract data from a GList and to produce a GList from
---   a list of pointers.
+-- Defines functions to extract data from a GList and to produce a GList from
+-- a list of pointers.
 --
 -- * The same for GSList.
 --
--- @documentation@ ------------------------------------------------------------
---
---
--- @todo@ ---------------------------------------------------------------------
---
---
 module GList(
   ptrToInt,
   GList,

Index: GValue.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/glib/GValue.chs,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- GValue.chs	9 Jul 2003 22:42:44 -0000	1.5
+++ GValue.chs	23 May 2004 16:00:53 -0000	1.6
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry GValue@
+--  GIMP Toolkit (GTK) GValue
 --
 --  Author : Axel Simon
 --          
@@ -19,15 +19,11 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * This module implements only the necessities for the GTK binding.
---
--- @documentation@ ------------------------------------------------------------
+-- |
 --
--- * Everything here is only used by @ref data TreeStore@ and friends.
+-- This module implements only the necessities for the GTK binding.
 --
--- @todo@ ---------------------------------------------------------------------
+-- * Everything here is only used by 'TreeStore' and friends.
 --
 module GValue(
   GenericValue(..),
@@ -46,10 +42,10 @@
 
 {#pointer *GValue -> GenericValue#}
 
--- @data GenericValue@ A union with information about the currently
+-- | A union with information about the currently
 -- stored type.
 --
--- * Internally used by @ref data TreeStore@.
+-- * Internally used by 'TreeStore'.
 --
 data GenericValue = GVuint    {#type guint#}
 		  | GVint     {#type gint#}
@@ -65,13 +61,13 @@
 		  | GVobject  GObject
 		  | GVboxed   (Ptr ())
 
--- @function valueInit@ Clear a GValue.
+-- | Clear a GValue.
 --
 valueInit :: GValue -> GType -> IO ()
 valueInit gv gt = liftM (const ()) $ {#call unsafe value_init#} gv gt
 
 
--- @function valueUnset@ Free the data in a GValue.
+-- | Free the data in a GValue.
 --
 valueUnset :: GValue -> IO ()
 valueUnset = {#call unsafe value_unset#}

Index: GObject.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/glib/GObject.chs,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- GObject.chs	7 May 2004 16:40:00 -0000	1.7
+++ GObject.chs	23 May 2004 16:00:53 -0000	1.8
@@ -1,6 +1,6 @@
 {-# OPTIONS -cpp #-}
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget GObject@
+--  GIMP Toolkit (GTK) Widget GObject
 --
 --  Author : Axel Simon
 --          
@@ -20,14 +20,10 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
---  * Implements the base GObject class to satisfy the type checker.
---
--- @documentation@ ------------------------------------------------------------
+-- |
 --
+-- Implements the base GObject class to satisfy the type checker.
 --
--- @todo@ ---------------------------------------------------------------------
 module GObject(
   objectNew,
   objectRef,
@@ -118,7 +114,7 @@
 
 #endif
 
--- @method objectWeakref@ attach a callback that will be called after the
+-- | attach a callback that will be called after the
 -- destroy hooks have been called
 --
 objectWeakref :: GObjectClass o => o -> IO () -> IO GWeakNotify
@@ -133,7 +129,7 @@
     {#call unsafe object_weak_ref#} objPtr uFunPtr nullPtr
   return uFunPtr
 
--- @method objectWeakunref@ detach a weak destroy callback function
+-- | detach a weak destroy callback function
 --
 objectWeakunref :: GObjectClass o => o -> GWeakNotify -> IO ()
 objectWeakunref obj fun = 

[Gtk2hs-commit] gtk2hs ChangeLog,1.159,1.160

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv15413

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.159
retrieving revision 1.160
diff -u -d -r1.159 -r1.160
--- ChangeLog	23 May 2004 15:58:50 -0000	1.159
+++ ChangeLog	23 May 2004 16:00:53 -0000	1.160
@@ -32,6 +32,10 @@
 	gtk/general/Structs.hsc, gtk/general/Style.chs:
 	initial haddockification
 
+	* gtk/glib/GList.chs, gtk/glib/GObject.chs, gtk/glib/GType.chs,
+	gtk/glib/GValue.chs, gtk/glib/GValueTypes.chs:
+	initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs ChangeLog,1.158,1.159

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14952

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.158
retrieving revision 1.159
diff -u -d -r1.158 -r1.159
--- ChangeLog	23 May 2004 15:55:37 -0000	1.158
+++ ChangeLog	23 May 2004 15:58:50 -0000	1.159
@@ -26,6 +26,12 @@
 	gtk/gdk/Keys.chs, gtk/gdk/Pixbuf.chs,
 	gtk/gdk/Region.chs: initial haddockification
 
+	* gtk/general/Enums.chs, gtk/general/FFI.hs,
+	gtk/general/General.chs, gtk/general/Gtk.hs,
+	gtk/general/IconFactory.chs, gtk/general/StockItems.hsc
+	gtk/general/Structs.hsc, gtk/general/Style.chs:
+	initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs ChangeLog,1.157,1.158

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14395

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.157
retrieving revision 1.158
diff -u -d -r1.157 -r1.158
--- ChangeLog	23 May 2004 15:51:53 -0000	1.157
+++ ChangeLog	23 May 2004 15:55:37 -0000	1.158
@@ -20,6 +20,12 @@
 	gtk/entry/HScale.chs, gtk/entry/SpinButton.chs,
 	gtk/entry/VScale.chs: initial haddockification
 
+	* gtk/gdk/DrawWindow.hs, gtk/gdk/Drawable.chs,
+	gtk/gdk/Events.hsc, gtk/gdk/GC.chs,
+	gtk/gdk/Gdk.chs, gtk/gdk/GdkEnums.chs,
+	gtk/gdk/Keys.chs, gtk/gdk/Pixbuf.chs,
+	gtk/gdk/Region.chs: initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs ChangeLog,1.156,1.157

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13585

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.156
retrieving revision 1.157
diff -u -d -r1.156 -r1.157
--- ChangeLog	23 May 2004 15:50:27 -0000	1.156
+++ ChangeLog	23 May 2004 15:51:53 -0000	1.157
@@ -16,6 +16,10 @@
 	gtk/display/Label.chs, gtk/display/ProgressBar.chs,
 	gtk/display/Statusbar.chs: initial haddockification
 
+	* gtk/entry/Entry.chs, gtk/entry/EntryCompletion.chs,
+	gtk/entry/HScale.chs, gtk/entry/SpinButton.chs,
+	gtk/entry/VScale.chs: initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs:

[Gtk2hs-commit] gtk2hs/gtk/entry Entry.chs,1.8,1.9 EntryCompletion.chs,1.2,1.3 HScale.chs,1.3,1.4 SpinButton.chs,1.4,1.5 VScale.chs,1.3,1.4

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

Update of /cvsroot/gtk2hs/gtk2hs/gtk/entry
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13585/gtk/entry

Modified Files:
	Entry.chs EntryCompletion.chs HScale.chs SpinButton.chs 
	VScale.chs 
Log Message:
initial haddockification


Index: VScale.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/entry/VScale.chs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- VScale.chs	9 Jul 2003 22:42:43 -0000	1.3
+++ VScale.chs	23 May 2004 15:51:53 -0000	1.4
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget VScale@
+--  GIMP Toolkit (GTK) Widget VScale
 --
 --  Author : Axel Simon
 --          
@@ -19,14 +19,13 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
+-- |
 --
 -- * The user may enter a value by moving the handle on the scale.
 --
--- @documentation@ ------------------------------------------------------------
 --
 --
--- @todo@ ---------------------------------------------------------------------
+-- * TODO
 
 module VScale(
   VScale,
@@ -46,7 +45,7 @@
 
 -- methods
 
--- @constructor vScaleNew@ Create a new VScale widget.
+-- | Create a new VScale widget.
 --
 vScaleNew :: Adjustment -> IO VScale
 vScaleNew adj = makeNewObject mkVScale $ liftM castPtr $

Index: SpinButton.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/entry/SpinButton.chs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- SpinButton.chs	9 Jul 2003 22:42:43 -0000	1.4
+++ SpinButton.chs	23 May 2004 15:51:53 -0000	1.5
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget SpinButton@
+--  GIMP Toolkit (GTK) Widget SpinButton
 --
 --  Author : Axel Simon
 --          
@@ -19,15 +19,14 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
+-- |
 --
 -- * A spin button provides the possiblity to enter a numeric value without
 --   using the keyboard.
 --
--- @documentation@ ------------------------------------------------------------
 --
 --
--- @todo@ ---------------------------------------------------------------------
+-- * TODO
 
 module SpinButton(
   SpinButton,
@@ -73,12 +72,12 @@
 
 -- methods
 
--- @constructor spinButtonNew@ Create a new SpinButton.
+-- | Create a new SpinButton.
 --
--- * @ref arg climbRate@ is the amount by which the value is changed each time
---   the up/down buttons are pressed.
+-- * @climbRate@ is the amount by which the value is changed each time
+--   the up\/down buttons are pressed.
 --
--- * @ref arg digits@ is the number of shown digits. Set to 0 to work with
+-- * @digits@ is the number of shown digits. Set to 0 to work with
 --   integer values.
 --
 spinButtonNew :: Adjustment -> Double -> Int -> IO SpinButton
@@ -86,101 +85,101 @@
   liftM castPtr $ {#call unsafe spin_button_new#} adj (realToFrac climbRate)
   (fromIntegral digits)
 
--- @method spinButtonNewWithRange@ Create a new SpinButton with a restricted
+-- | Create a new SpinButton with a restricted
 -- range.
 --
 -- * This is a convenience function because the user does not have to create
---   an Adjustment first. Page increments are set to 10 * @ref arg step@.
+--   an Adjustment first. Page increments are set to 10 * @step@.
 --
 spinButtonNewWithRange :: Double -> Double -> Double -> IO SpinButton
 spinButtonNewWithRange min max step = makeNewObject mkSpinButton $
   liftM castPtr $ {#call unsafe spin_button_new_with_range#}
   (realToFrac min) (realToFrac max) (realToFrac step)
 
--- @method spinButtonConfigure@ Change the settings of a SpinButton.
+-- | Change the settings of a SpinButton.
 --
 spinButtonConfigure :: SpinButtonClass sb => sb -> Adjustment -> Double ->
                        Int -> IO ()
 spinButtonConfigure sb adj climbRate digits = {#call spin_button_configure#}
   (toSpinButton sb) adj (realToFrac climbRate) (fromIntegral digits)
 
--- @method spinButtonSetAdjustment@ Attach a new Adjustment object to the
+-- | Attach a new Adjustment object to the
 -- SpinButton.
 --
 spinButtonSetAdjustment :: SpinButtonClass sb => sb -> Adjustment -> IO ()
 spinButtonSetAdjustment sb adj = {#call spin_button_set_adjustment#}
   (toSpinButton sb) adj
 
--- @method spinButtonGetAdjustment@ Retrieve the Adjustment object that is
+-- | Retrieve the Adjustment object that is
 -- currently controlling the SpinButton.
 --
 spinButtonGetAdjustment :: SpinButtonClass sb => sb -> IO Adjustment
 spinButtonGetAdjustment sb = makeNewObject mkAdjustment $
   {#call unsafe spin_button_get_adjustment#} (toSpinButton sb)
 
--- @method spinButtonSetDigits@ Sets the number of shown digits.
+-- | Sets the number of shown digits.
 --
 spinButtonSetDigits :: SpinButtonClass sb => sb -> Int -> IO ()
 spinButtonSetDigits sb digits = {#call spin_button_set_digits#} 
   (toSpinButton sb) (fromIntegral digits)
 
--- @method spinButtonSetIncrements@ Sets the increment for up/down buttons.
+-- | Sets the increment for up\/down buttons.
 --
 spinButtonSetIncrements :: SpinButtonClass sb => sb -> Double -> Double ->
                            IO ()
 spinButtonSetIncrements sb step page = {#call spin_button_set_increments#}
   (toSpinButton sb) (realToFrac step) (realToFrac page)
 
--- @method spinButtonSetRange@ Set the maximal allowable range for the
+-- | Set the maximal allowable range for the
 -- spinbutton.
 --
 spinButtonSetRange :: SpinButtonClass sb => sb -> Double -> Double -> IO ()
 spinButtonSetRange sb min max = {#call spin_button_set_range#}
   (toSpinButton sb) (realToFrac min) (realToFrac max)
 
--- @method spinButtonGetValue@ Retrieve the current value as a floating point
+-- | Retrieve the current value as a floating point
 -- value.
 --
 spinButtonGetValue :: SpinButtonClass sb => sb -> IO Double
 spinButtonGetValue sb = liftM realToFrac $
   {#call unsafe spin_button_get_value#} (toSpinButton sb)
 
--- @method spinButtonGetValueAsInt@ Retrieve the current value as integral
+-- | Retrieve the current value as integral
 -- value.
 --
 spinButtonGetValueAsInt :: SpinButtonClass sb => sb -> IO Int
 spinButtonGetValueAsInt sb = liftM fromIntegral $
   {#call unsafe spin_button_get_value_as_int#} (toSpinButton sb)
 
--- @method spinButtonSetValue@ Set the value of the SpinButton.
+-- | Set the value of the SpinButton.
 --
 spinButtonSetValue :: SpinButtonClass sb => sb -> Double -> IO ()
 spinButtonSetValue sb value = {#call spin_button_set_value#}
   (toSpinButton sb) (realToFrac value)
 
--- @method spinButtonSetUpdatePolicy@ Whether the an out-of-range value set by
--- @ref method spinButtonSetValue@ is clamped to the limits or simply ignored.
+-- | Whether the an out-of-range value set by
+-- 'spinButtonSetValue' is clamped to the limits or simply ignored.
 --
 spinButtonSetUpdatePolicy :: SpinButtonClass sb => sb ->
                              SpinButtonUpdatePolicy -> IO ()
 spinButtonSetUpdatePolicy sb up = {#call spin_button_set_update_policy#}
   (toSpinButton sb) ((fromIntegral.fromEnum) up)
 
--- @method spinButtonSetNumeric@ Sets the flag that determines if non-numeric
+-- | Sets the flag that determines if non-numeric
 -- text can be typed into the spin button.
 --
 spinButtonSetNumeric :: SpinButtonClass sb => sb -> Bool -> IO ()
 spinButtonSetNumeric sb numeric = {#call spin_button_set_numeric#}
   (toSpinButton sb) (fromBool numeric)
 
--- @method spinButtonSpin@ Increment or decrement the current value of the
+-- | Increment or decrement the current value of the
 -- SpinButton.
 --
 spinButtonSpin :: SpinButtonClass sb => sb -> SpinType -> Double -> IO ()
 spinButtonSpin sb st offset = {#call spin_button_spin#} (toSpinButton sb)
   ((fromIntegral.fromEnum) st) (realToFrac offset)
 
--- @method spinButtonSetWrap@ Sets the flag that determines if a spin button
+-- | Sets the flag that determines if a spin button
 -- value wraps around to the opposite limit when the upper or lower limit of
 -- the range is exceeded.
 --
@@ -188,7 +187,7 @@
 spinButtonSetWrap sb wrap = {#call spin_button_set_wrap#} (toSpinButton sb)
   (fromBool wrap)
 
--- @method spinButtonSetSnapToTicks@ Sets the policy as to whether values are
+-- | Sets the policy as to whether values are
 -- corrected to the nearest step increment when a spin button is activated
 -- after providing an invalid value.
 --
@@ -197,14 +196,14 @@
   {#call spin_button_set_snap_to_ticks#} (toSpinButton sb) 
   (fromBool snapToTicks)
 
--- @method spinButtonUpdate@ Force an update of the SpinButton.
+-- | Force an update of the SpinButton.
 --
 spinButtonUpdate :: SpinButtonClass sb => sb -> IO ()
 spinButtonUpdate sb = {#call spin_button_update#} (toSpinButton sb)
 
 -- signals
 
--- @signal connectToInput@ Install a custom input handler.
+-- | Install a custom input handler.
 --
 -- * This signal is called upon each time the value of the SpinButton is set
 --   by spinButtonSetValue. The function can return Nothing if the value is no
@@ -227,7 +226,7 @@
       return 0
     Nothing -> return (toInteger inputError)
 
--- @signal connectToOutput@ Install a custom output handler.
+-- | Install a custom output handler.
 --
 -- * This handler makes it possible to query the current value and to render
 --   something completely different to the screen using entrySetText. The
@@ -239,7 +238,7 @@
 onOutput = connect_NONE__BOOL "output" False
 afterOutput = connect_NONE__BOOL "output" True
 
--- @signal connectToValueSpinned@ The value of the spin button has changed.
+-- | The value of the spin button has changed.
 --
 onValueSpinned, afterValueSpinned :: SpinButtonClass sb => sb -> IO () ->
                                      IO (ConnectId sb)

Index: Entry.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/entry/Entry.chs,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- Entry.chs	27 Apr 2004 18:51:14 -0000	1.8
+++ Entry.chs	23 May 2004 15:51:52 -0000	1.9
@@ -1,6 +1,6 @@
 {-# OPTIONS -cpp #-}
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget Entry@
+--  GIMP Toolkit (GTK) Widget Entry
 --
 --  Author : Axel Simon
 --          
@@ -20,14 +20,13 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
+-- |
 --
 -- * This widget lets the user enter a single line of text.
 --
--- @documentation@ ------------------------------------------------------------
 --
 --
--- @todo@ ---------------------------------------------------------------------
+-- * TODO
 --
 -- * A couple of signals are not bound because I could not figure out what
 --   they mean. Some of them do not seem to be emitted at all.
@@ -102,19 +101,19 @@
 toEditable :: EntryClass ed => ed -> Editable
 toEditable = Editable . castForeignPtr . unEntry . toEntry
 
--- @method entrySelectRegion@ Select a span of text.
+-- | Select a span of text.
 --
--- * A negative @ref arg end@ position will make the selection extend to the
+-- * A negative @end@ position will make the selection extend to the
 --   end of the buffer.
 --
--- * Calling this function with @ref arg start@=1 and @ref arg end@=4 it will
---   mark "ask" in the string "Haskell". (FIXME: verify)
+-- * Calling this function with @start@=1 and @end@=4 it will
+--   mark \"ask\" in the string \"Haskell\". (FIXME: verify)
 --
 entrySelectRegion :: EntryClass ed => ed -> Int -> Int -> IO ()
 entrySelectRegion ed start end = {#call editable_select_region#}
   (toEditable ed) (fromIntegral start) (fromIntegral end)
 
--- @method entryGetSelectionBounds@ Get the span of the current selection.
+-- | Get the span of the current selection.
 --
 -- * The returned tuple is not ordered. The second index represents the
 --   position of the cursor. The first index is the other end of the
@@ -127,7 +126,7 @@
   end	<- liftM fromIntegral $ peek endPtr
   return (start,end)
 
--- @method entryInsertText@ Insert new text at the specified position.
+-- | Insert new text at the specified position.
 --
 -- * If the position is invalid the text will be inserted at the end of the
 --   buffer. The returned value reflects the actual insertion point.
@@ -139,20 +138,20 @@
       posPtr
     liftM fromIntegral $ peek posPtr
 
--- @method entryDeleteText@ Delete a given range of text.
+-- | Delete a given range of text.
 --
--- * If the @ref arg end@ position is invalid, it is set to the lenght of the
+-- * If the @end@ position is invalid, it is set to the lenght of the
 --   buffer.
 --
--- * @ref arg start@ is restricted to 0..@ref arg end@.
+-- * @start@ is restricted to 0..@end@.
 --
 entryDeleteText :: EntryClass ed => ed -> Int -> Int -> IO ()
 entryDeleteText ed start end = {#call editable_delete_text#} (toEditable ed)
   (fromIntegral start) (fromIntegral end)
 
--- @method entryGetChars@ Retrieve a range of characters.
+-- | Retrieve a range of characters.
 --
--- * Set @ref arg end@ to a negative value to reach the end of the buffer.
+-- * Set @end@ to a negative value to reach the end of the buffer.
 --
 entryGetChars :: EntryClass ed => ed -> Int -> Int -> IO String
 entryGetChars ed start end = do
@@ -162,40 +161,40 @@
   {#call unsafe g_free#} (castPtr strPtr)
   return str
 
--- @method entryCutClipboard@ Cut the selected characters to the Clipboard.
+-- | Cut the selected characters to the Clipboard.
 --
 entryCutClipboard :: EntryClass ed => ed -> IO ()
 entryCutClipboard  = {#call editable_cut_clipboard#}.toEditable
 
--- @method entryCopyClipboard@ Copy the selected characters to the Clipboard.
+-- | Copy the selected characters to the Clipboard.
 --
 entryCopyClipboard :: EntryClass ed => ed -> IO ()
 entryCopyClipboard  = {#call editable_copy_clipboard#}.toEditable
 
--- @method entryPasteClipboard@ Paste the selected characters to the
+-- | Paste the selected characters to the
 -- Clipboard.
 --
 entryPasteClipboard :: EntryClass ed => ed -> IO ()
 entryPasteClipboard  = {#call editable_paste_clipboard#}.toEditable
 
--- @method entryDeleteSelection@ Delete the current selection.
+-- | Delete the current selection.
 --
 entryDeleteSelection :: EntryClass ed => ed -> IO ()
 entryDeleteSelection  = {#call editable_delete_selection#}.toEditable
 
--- @method entrySetPosition@ Set the cursor to a specific position.
+-- | Set the cursor to a specific position.
 --
 entrySetPosition :: EntryClass ed => ed -> Int -> IO ()
 entrySetPosition ed pos = 
   {#call editable_set_position#} (toEditable ed) (fromIntegral pos)
 
--- @method entryGetPosition@ Get the current cursor position.
+-- | Get the current cursor position.
 --
 entryGetPosition :: EntryClass ed => ed -> IO Int
 entryGetPosition ed = liftM fromIntegral $
   {#call unsafe editable_get_position#} (toEditable ed)
 
--- @method entrySetEditable@ Make an @ref type Entry@ insensitive.
+-- | Make an 'Entry' insensitive.
 --
 -- * Called with False will make the text uneditable.
 --
@@ -206,51 +205,51 @@
 
 -- methods
 
--- @constructor entryNew@ Create a new @ref type Entry@ widget.
+-- | Create a new 'Entry' widget.
 --
 entryNew :: IO Entry
 entryNew  = makeNewObject mkEntry $ liftM castPtr $ {#call unsafe entry_new#}
 
--- @method entrySetText@ Set the text of the @ref type Entry@ widget.
+-- | Set the text of the 'Entry' widget.
 --
 entrySetText :: EntryClass ec => ec -> String -> IO ()
 entrySetText ec str = withUTFString str $ {#call entry_set_text#} (toEntry ec)
 
--- @method entryGetText@ Get the text of the @ref type Entry@ widget.
+-- | Get the text of the 'Entry' widget.
 --
 entryGetText :: EntryClass ec => ec -> IO String
 entryGetText ec = {#call entry_get_text#} (toEntry ec) >>= peekUTFString
 
--- @method entryAppendText@ Append to the text of the @ref type Entry@ widget.
+-- | Append to the text of the 'Entry' widget.
 --
 entryAppendText :: EntryClass ec => ec -> String -> IO ()
 entryAppendText ec str = 
   withUTFString str $ {#call entry_append_text#} (toEntry ec)
 
--- @method entryPrependText@ Prepend the text of the @ref type Entry@ widget.
+-- | Prepend the text of the 'Entry' widget.
 --
 entryPrependText :: EntryClass ec => ec -> String -> IO ()
 entryPrependText ec str = 
   withUTFString str $ {#call entry_prepend_text#} (toEntry ec)
 
--- @method entrySetVisibility@ Set whether to use password mode (display stars
+-- | Set whether to use password mode (display stars
 -- instead of the text).
 --
 -- * The replacement character can be changed with
---   @ref method entrySetInvisibleChar@.
+--   'entrySetInvisibleChar'.
 --
 entrySetVisibility :: EntryClass ec => ec -> Bool -> IO ()
 entrySetVisibility ec visible =
   {#call entry_set_visibility#} (toEntry ec) (fromBool visible)
 
--- @method entrySetInvisibleChar@ Set the replacement character for invisible
+-- | Set the replacement character for invisible
 -- text.
 --
 entrySetInvisibleChar :: EntryClass ec => ec -> Char -> IO ()
 entrySetInvisibleChar ec ch =
   {#call unsafe entry_set_invisible_char#} (toEntry ec) ((fromIntegral.ord) ch)
 
--- @method entrySetMaxLength@ Sets a maximum length the text may grow to.
+-- | Sets a maximum length the text may grow to.
 --
 -- * A negative number resets the restriction.
 --
@@ -258,45 +257,45 @@
 entrySetMaxLength ec max = 
   {#call entry_set_max_length#} (toEntry ec) (fromIntegral max)
 
--- @method entryGetActivatesDefault@ Query whether pressing return will
+-- | Query whether pressing return will
 -- activate the default widget.
 --
 entryGetActivatesDefault :: EntryClass ec => ec -> IO Bool
 entryGetActivatesDefault ec = liftM toBool $
   {#call unsafe entry_get_activates_default#} (toEntry ec)
 
--- @method entrySetActivatesDefault@ Specify if pressing return will activate
+-- | Specify if pressing return will activate
 -- the default widget.
 --
--- * This setting is useful in @ref data Dialog@ boxes where enter should press
+-- * This setting is useful in 'Dialog' boxes where enter should press
 --   the default button.
 --
 entrySetActivatesDefault :: EntryClass ec => ec -> Bool -> IO ()
 entrySetActivatesDefault ec setting = {#call entry_set_activates_default#}
   (toEntry ec) (fromBool setting)
 
--- @method entryGetHasFrame@ Query if the text @ref type Entry@ is displayed
+-- | Query if the text 'Entry' is displayed
 -- with a frame around it.
 --
 entryGetHasFrame :: EntryClass ec => ec -> IO Bool
 entryGetHasFrame ec = liftM toBool $
   {#call unsafe entry_get_has_frame#} (toEntry ec)
 
--- @method entrySetHasFrame@ Specifies whehter the @ref type Entry@ should be
+-- | Specifies whehter the 'Entry' should be
 -- in an etched-in frame.
 --
 entrySetHasFrame :: EntryClass ec => ec -> Bool -> IO ()
 entrySetHasFrame ec setting = {#call entry_set_has_frame#}
   (toEntry ec) (fromBool setting)
 
--- @method entryGetWidthChars@ Retrieve the number of characters the widget
+-- | Retrieve the number of characters the widget
 -- should ask for.
 --
 entryGetWidthChars :: EntryClass ec => ec -> IO Int
 entryGetWidthChars ec = liftM fromIntegral $ 
   {#call unsafe entry_get_width_chars#} (toEntry ec)
 
--- @method entrySetWidthChars@ Specifies how large the @ref type Entry@ should
+-- | Specifies how large the 'Entry' should
 -- be in characters.
 --
 -- * This setting is only considered when the widget formulates its size
@@ -308,7 +307,7 @@
   (toEntry ec) (fromIntegral setting)
 
 #if GTK_CHECK_VERSION(2,4,0)
--- @method entrySetCompletion@ Sets the auxiliary completion object to use with
+-- | Sets the auxiliary completion object to use with
 -- the entry. All further configuration of the completion mechanism is done on
 -- completion using the GtkEntryCompletion API.
 --
@@ -318,7 +317,7 @@
 entrySetCompletion ec completion = {#call gtk_entry_set_completion#}
   (toEntry ec) completion
 
--- @method entryGetCompletion@ Returns the auxiliary completion object currently
+-- | Returns the auxiliary completion object currently
 -- in use by entry
 --
 -- * Since gtk 2.4
@@ -332,23 +331,23 @@
 
 -- signals
 
--- @signal connectToEntryActivate@ Emitted when the user presses return within
--- the @ref data Entry@ field.
+-- | Emitted when the user presses return within
+-- the 'Entry' field.
 --
 onEntryActivate, afterEntryActivate :: EntryClass ec => ec -> IO () ->
                                        IO (ConnectId ec)
 onEntryActivate = connect_NONE__NONE "activate" False
 afterEntryActivate = connect_NONE__NONE "activate" True
 
--- @signal connectToEntryChanged@ Emitted when the settings of the
--- @ref data Entry@ widget changes.
+-- | Emitted when the settings of the
+-- 'Entry' widget changes.
 --
 onEntryChanged, afterEntryChanged :: EntryClass ec => ec -> IO () ->
                                      IO (ConnectId ec)
 onEntryChanged = connect_NONE__NONE "changed" False
 afterEntryChanged = connect_NONE__NONE "changed" True
 
--- @signal connectToCopyClipboard@ Emitted when the current selection has been
+-- | Emitted when the current selection has been
 -- copied to the clipboard.
 --
 onCopyClipboard, afterCopyClipboard :: EntryClass ec => ec -> IO () ->
@@ -356,7 +355,7 @@
 onCopyClipboard = connect_NONE__NONE "copy_clipboard" False
 afterCopyClipboard = connect_NONE__NONE "copy_clipboard" True
 
--- @signal connectToCutClipboard@ Emitted when the current selection has been
+-- | Emitted when the current selection has been
 -- cut to the clipboard.
 --
 onCutClipboard, afterCutClipboard :: EntryClass ec => ec -> IO () ->
@@ -364,7 +363,7 @@
 onCutClipboard = connect_NONE__NONE "cut_clipboard" False
 afterCutClipboard = connect_NONE__NONE "cut_clipboard" True
 
--- @signal connectToPasteClipboard@ Emitted when the current selection has
+-- | Emitted when the current selection has
 -- been pasted from the clipboard.
 --
 onPasteClipboard, afterPasteClipboard :: EntryClass ec => ec -> IO () ->
@@ -372,15 +371,15 @@
 onPasteClipboard = connect_NONE__NONE "paste_clipboard" False
 afterPasteClipboard = connect_NONE__NONE "paste_clipboard" True
 
--- @signal connectToDeleteText@ Emitted when a piece of text is deleted from
--- the @ref data Entry@.
+-- | Emitted when a piece of text is deleted from
+-- the 'Entry'.
 --
 onDeleteText, afterDeleteText :: EntryClass ec => ec ->
                                  (Int -> Int -> IO ()) -> IO (ConnectId ec)
 onDeleteText = connect_INT_INT__NONE "delete_text" False
 afterDeleteText = connect_INT_INT__NONE "delete_text" True
 
--- @signal connectToInsertAtCursor@ Emitted when a piece of text is inserted
+-- | Emitted when a piece of text is inserted
 -- at the cursor position.
 --
 onInsertAtCursor, afterInsertAtCursor :: EntryClass ec => ec ->
@@ -389,7 +388,7 @@
 onInsertAtCursor = connect_STRING__NONE "insert_at_cursor" False
 afterInsertAtCursor = connect_STRING__NONE "insert_at_cursor" True
 
--- @signal connectToToggleOverwrite@ Emitted when the user changes from
+-- | Emitted when the user changes from
 -- overwriting to inserting.
 --
 onToggleOverwrite, afterToggleOverwrite :: EntryClass ec => ec -> IO () ->

Index: HScale.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/entry/HScale.chs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- HScale.chs	9 Jul 2003 22:42:43 -0000	1.3
+++ HScale.chs	23 May 2004 15:51:53 -0000	1.4
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget HScale@
+--  GIMP Toolkit (GTK) Widget HScale
 --
 --  Author : Axel Simon
 --          
@@ -19,14 +19,13 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
+-- |
 --
 -- * The user may enter a value by moving the handle on the scale.
 --
--- @documentation@ ------------------------------------------------------------
 --
 --
--- @todo@ ---------------------------------------------------------------------
+-- * TODO
 
 module HScale(
   HScale,
@@ -46,7 +45,7 @@
 
 -- methods
 
--- @constructor hScaleNew@ Create a new HScale widget.
+-- | Create a new HScale widget.
 --
 hScaleNew :: Adjustment -> IO HScale
 hScaleNew adj = makeNewObject mkHScale $ liftM castPtr $

Index: EntryCompletion.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/entry/EntryCompletion.chs,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- EntryCompletion.chs	30 Apr 2004 13:12:57 -0000	1.2
+++ EntryCompletion.chs	23 May 2004 15:51:53 -0000	1.3
@@ -1,6 +1,6 @@
 {-# OPTIONS -cpp #-}
 -- -*-haskell-*-
--- |GIMP Toolkit (GTK) @entry Widget EntryCompletion@
+--  GIMP Toolkit (GTK) entry Widget EntryCompletion
 --
 --  Author : Duncan Coutts
 --  Created: 24 April 2004
@@ -17,13 +17,11 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 --  Library General Public License for more details.
 --
---- Description ---------------------------------------------------------------
---
---  Language: Haskell 98 Binding Module
+-- |
 --
---  Completion functionality for the Entry widget.
+-- Completion functionality for the Entry widget.
 --
---  Added in GTK+ 2.4
+-- * Added in GTK+ 2.4
 --
 
 module EntryCompletion (

[Gtk2hs-commit] gtk2hs/gtk/display AccelLabel.chs,1.4,1.5 Image.chs,1.5,1.6 Label.chs,1.5,1.6 ProgressBar.chs,1.4,1.5 Statusbar.chs,1.3,1.4

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

Update of /cvsroot/gtk2hs/gtk2hs/gtk/display
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13363/gtk/display

Modified Files:
	AccelLabel.chs Image.chs Label.chs ProgressBar.chs 
	Statusbar.chs 
Log Message:
initial haddockification


Index: Image.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/display/Image.chs,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- Image.chs	9 Jul 2003 22:42:43 -0000	1.5
+++ Image.chs	23 May 2004 15:50:26 -0000	1.6
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget Image@
+--  GIMP Toolkit (GTK) Widget Image
 --
 --  Author : Axel Simon
 --          
@@ -19,20 +19,19 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
+-- |
 --
--- * This widget displays an image.
+-- This widget displays an image.
 --
--- @documentation@ ------------------------------------------------------------
 --
 -- * Because Haskell is not the best language to modify large images directly
 --   only functions are bound that allow loading images from disc or by stock
 --   names.
 --
--- * Another function for extracting the @ref data Pixbuf@ is added for 
---   @ref data CellRenderer@.
+-- * Another function for extracting the 'Pixbuf' is added for 
+--   'CellRenderer'.
 --
--- @todo@ ---------------------------------------------------------------------
+-- TODO
 --
 -- * Figure out what other functions are useful within Haskell. Maybe we should
 --   support loading Pixmaps without exposing them.
@@ -67,13 +66,13 @@
 
 -- methods
 
--- @method imageNewFromFile@ Create an image by loading a file.
+-- | Create an image by loading a file.
 --
 imageNewFromFile :: FilePath -> IO Image
 imageNewFromFile path = makeNewObject mkImage $ liftM castPtr $ 
   withUTFString path {#call unsafe image_new_from_file#}
 
--- @method imageNewFromStock@ Create a set of images by specifying a stock
+-- | Create a set of images by specifying a stock
 -- object.
 --
 imageNewFromStock :: String -> IconSize -> IO Image
@@ -81,7 +80,7 @@
   makeNewObject mkImage $ liftM castPtr $ {#call unsafe image_new_from_stock#}
   strPtr (fromIntegral ic)
 
--- @method imageGetPixbuf@ Extract the Pixbuf from the @ref data Image@.
+-- | Extract the Pixbuf from the 'Image'.
 --
 imageGetPixbuf :: Image -> IO Pixbuf
 imageGetPixbuf img = makeNewGObject mkPixbuf $ liftM castPtr $
@@ -89,8 +88,8 @@
   {#call unsafe image_get_pixbuf#} img
 
 
--- @method imageNewFromPixbuf@ Create an @ref data Image@ from a 
--- @ref data Pixbuf@.
+-- | Create an 'Image' from a 
+-- 'Pixbuf'.
 --
 imageNewFromPixbuf :: Pixbuf -> IO Image
 imageNewFromPixbuf pbuf = makeNewObject mkImage $ liftM castPtr $

Index: ProgressBar.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/display/ProgressBar.chs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- ProgressBar.chs	9 Jul 2003 22:42:43 -0000	1.4
+++ ProgressBar.chs	23 May 2004 15:50:26 -0000	1.5
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget ProgressBar@
+--  GIMP Toolkit (GTK) Widget ProgressBar
 --
 --  Author : Axel Simon
 --          
@@ -19,15 +19,11 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * The ProgressBar provides a means for an application to keep the user
---   patient while some time intensive task is going on.
---
--- @documentation@ ------------------------------------------------------------
+-- |
 --
+-- The ProgressBar provides a means for an application to keep the user
+-- patient while some time intensive task is going on.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module ProgressBar(
   ProgressBar,
@@ -58,30 +54,30 @@
 
 -- methods
 
--- @constructor progressBarNew@ Create a new ProgreeBar.
+-- | Create a new ProgreeBar.
 --
 progressBarNew :: IO ProgressBar
 progressBarNew  = makeNewObject mkProgressBar $ liftM castPtr $
   {#call unsafe progress_bar_new#}
 
--- @method progressBarPulse@ Indicates that some progress is made, but you
--- don't know how much. Causes the progress bar to enter `activity mode',
+-- | Indicates that some progress is made, but you
+-- don't know how much. Causes the progress bar to enter \`activity mode',
 -- where a block bounces back and forth. Each call to
--- @ref method progressBarPulse@ causes the block to move on by a little bit
+-- 'progressBarPulse' causes the block to move on by a little bit
 -- (the amount of movement per pulse is determined by
--- @ref method progressBarSetPulseStep@).
+-- 'progressBarSetPulseStep').
 --
 progressBarPulse :: ProgressBarClass pb => pb -> IO ()
 progressBarPulse pb = {#call unsafe progress_bar_pulse#} (toProgressBar pb)
 
--- @method progressBarSetText@ Causes the given @ref arg text@ to appear
+-- | Causes the given @text@ to appear
 -- superimposed on the progress bar.
 --
 progressBarSetText :: ProgressBarClass pb => pb -> String -> IO ()
 progressBarSetText pb text = withUTFString text $
   {#call unsafe progress_bar_set_text#} (toProgressBar pb)
 
--- @method progressBarSetFraction@ Causes the progress bar to `fill in' the
+-- | Causes the progress bar to \`fill in' the
 -- given fraction of the bar. The fraction should be between 0.0 and 1.0,
 -- inclusive.
 --
@@ -89,24 +85,24 @@
 progressBarSetFraction pb fraction = {#call unsafe progress_bar_set_fraction#}
   (toProgressBar pb) (realToFrac fraction)
 
--- @method progressBarSetPulseStep@ Sets the fraction of total progress bar
+-- | Sets the fraction of total progress bar
 -- length to move the bouncing block for each call to progressBarPulse.
 --
--- * The @ref arg fraction@ parameter must be between 0.0 and 1.0.
+-- * The @fraction@ parameter must be between 0.0 and 1.0.
 --
 progressBarSetPulseStep :: ProgressBarClass pb => pb -> Double -> IO ()
 progressBarSetPulseStep pb fraction = 
   {#call unsafe progress_bar_set_pulse_step#} (toProgressBar pb) 
   (realToFrac fraction)
 
--- @method progressBarGetFraction@ Returns the current fraction of the task
+-- | Returns the current fraction of the task
 -- that has been completed.
 --
 progressBarGetFraction :: ProgressBarClass pb => pb -> IO Double
 progressBarGetFraction pb = liftM realToFrac $ 
   {#call unsafe progress_bar_get_fraction#} (toProgressBar pb)
 
--- @method progressBarGetPulseStep@ Returns the current pulseStep of the task
+-- | Returns the current pulseStep of the task
 -- that has been completed.
 --
 progressBarGetPulseStep :: ProgressBarClass pb => pb -> IO Double
@@ -114,7 +110,7 @@
   {#call unsafe progress_bar_get_pulse_step#} (toProgressBar pb)
 
 
--- @method progressBarGetText@ Retrieve the text displayed superimposed on the
+-- | Retrieve the text displayed superimposed on the
 -- ProgressBar.
 --
 -- * Returns Nothing if no text was set.
@@ -124,7 +120,7 @@
   strPtr <- {#call unsafe progress_bar_get_text#} (toProgressBar pb)
   if strPtr==nullPtr then return Nothing else liftM Just $ peekUTFString strPtr
 
--- @method progressBarSetOrientation@ Causes the progress bar to switch to a
+-- | Causes the progress bar to switch to a
 -- different orientation (left-to-right, right-to-left, top-to-bottom, or
 -- bottom-to-top).
 --
@@ -134,7 +130,7 @@
   {#call progress_bar_set_orientation#} (toProgressBar pb)
   ((fromIntegral.fromEnum) orientation)
 
--- @method progressBarGetOrientation@ Retrieve the current ProgressBar
+-- | Retrieve the current ProgressBar
 -- orientation.
 --
 progressBarGetOrientation :: ProgressBarClass pb => pb ->

Index: Statusbar.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/display/Statusbar.chs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- Statusbar.chs	9 Jul 2003 22:42:43 -0000	1.3
+++ Statusbar.chs	23 May 2004 15:50:26 -0000	1.4
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget StatusBar@
+--  GIMP Toolkit (GTK) Widget StatusBar
 --
 --  Author : Axel Simon
 --          
@@ -19,18 +19,17 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * GtkStatusbar -- report messages of minor importance to the user.
+-- |
 --
--- @documentation@ ------------------------------------------------------------
+-- Report messages of minor importance to the user.
 --
 -- * A Statusbar is usually placed along the bottom of an application's main
 --   Window. It may provide a regular commentary of the application's status 
 --   (as is usually the case in a web browser, for example), or may be used to
 --   simply output a message when the status changes, (when an upload is 
 --   complete in an FTP client, for example).
---   Status bars in Gtk+ maintain a stack of messages. The message at the top
+--
+-- * Status bars in Gtk+ maintain a stack of messages. The message at the top
 --   of the each bar's stack is the one that will currently be displayed.
 --   Any messages added to a statusbar's stack must specify a ContextId that
 --   is used to uniquely identify the source of a message. This ContextId can
@@ -43,7 +42,6 @@
 --   removed from anywhere in the stack if it's MessageId was recorded at the
 --   time it was added. This is done using statusbarRemove.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module Statusbar(
   Statusbar,
@@ -73,7 +71,7 @@
 
 -- methods
 
--- @constructor statusbarNew@ Create a new Statusbar.
+-- | Create a new Statusbar.
 --
 statusbarNew :: IO Statusbar
 statusbarNew  = makeNewObject mkStatusbar $ 
@@ -81,7 +79,7 @@
 
 type ContextId = {#type guint#}
 
--- @method statusbarGetContextId@ Given a context description, this function
+-- | Given a context description, this function
 -- returns a ContextId. This id can be used to later remove entries form the
 -- Statusbar.
 --
@@ -92,32 +90,32 @@
 
 type MessageId = {#type guint#}
 
--- @method statusbarPush@ Push a new message on the Statusbar stack. It will
+-- | Push a new message on the Statusbar stack. It will
 -- be displayed as long as it is on top of the stack.
 --
 statusbarPush :: StatusbarClass sb => sb -> ContextId -> String -> IO MessageId
 statusbarPush sb context msg = withUTFString msg $ {#call statusbar_push#}
   (toStatusbar sb) context
 
--- @method statusbarPop@ Pops the topmost message that has the correct
+-- | Pops the topmost message that has the correct
 -- context.
 --
 statusbarPop :: StatusbarClass sb => sb -> ContextId -> IO ()
 statusbarPop sb context = {#call statusbar_pop#} (toStatusbar sb) context
 
--- @method statusbarRemove@ Remove an entry within the stack.
+-- | Remove an entry within the stack.
 --
 statusbarRemove :: StatusbarClass sb => sb -> ContextId -> MessageId -> IO ()
 statusbarRemove sb context message = {#call statusbar_remove#} (toStatusbar sb)
   context message
 
--- @method statusbarSetHasResizeGrip@ Toggle the displaying of a resize grip.
+-- | Toggle the displaying of a resize grip.
 --
 statusbarSetHasResizeGrip :: StatusbarClass sb => sb -> Bool -> IO ()
 statusbarSetHasResizeGrip sb set = {#call statusbar_set_has_resize_grip#}
   (toStatusbar sb) (fromBool set)
 
--- @method statusbarGetHasResizeGrip@ Query the displaying of the resize grip.
+-- | Query the displaying of the resize grip.
 --
 statusbarGetHasResizeGrip :: StatusbarClass sb => sb -> IO Bool
 statusbarGetHasResizeGrip sb = liftM toBool $
@@ -125,7 +123,7 @@
 
 -- signals
 
--- @signal connectToTextPopped@ Called if a message is removed.
+-- | Called if a message is removed.
 --
 onTextPopped, afterTextPopped :: StatusbarClass sb => sb ->
                                  (ContextId -> String -> IO ()) ->
@@ -133,7 +131,7 @@
 onTextPopped = connect_WORD_STRING__NONE "text-popped" False
 afterTextPopped = connect_WORD_STRING__NONE "text-popped" True
 
--- @signal connectToTextPushed@ Called if a message is pushed on top of the
+-- | Called if a message is pushed on top of the
 -- stack.
 --
 onTextPushed, afterTextPushed :: StatusbarClass sb => sb ->

Index: AccelLabel.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/display/AccelLabel.chs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- AccelLabel.chs	9 Jul 2003 22:42:43 -0000	1.4
+++ AccelLabel.chs	23 May 2004 15:50:26 -0000	1.5
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget AccelLabel@
+--  GIMP Toolkit (GTK) Widget AccelLabel
 --
 --  Author : Axel Simon
 --          
@@ -19,17 +19,14 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
--- * This widget is a special version of @ref data Label@. It displays an 
---   accelerator
---   key next to the Label. The key name is not explicitly set but taken from
---   the key that is associated with the activation of another widget.
+-- |
 --
--- @documentation@ ------------------------------------------------------------
+-- This widget is a special version of 'Label'. It displays an 
+-- accelerator key next to the Label.
 --
+-- * The key name is not explicitly set but taken from the key that
+--   is associated with the activation of another widget.
 --
--- @todo@ ---------------------------------------------------------------------
 
 module AccelLabel(
   AccelLabel,
@@ -50,13 +47,13 @@
 
 -- methods
 
--- @constructor accelLabelNew@ Create a new label with an accelerator key.
+-- | Create a new label with an accelerator key.
 --
 accelLabelNew :: String -> IO AccelLabel
 accelLabelNew str = withUTFString str $ \strPtr -> makeNewObject mkAccelLabel $ 
   liftM castPtr $ {#call unsafe accel_label_new#} strPtr
 
--- @method accelLabelSetAccelWidget@ Set the key name from the activation
+-- | Set the key name from the activation
 -- signal of another widget.
 --
 accelLabelSetAccelWidget :: (AccelLabelClass acl, WidgetClass w) => acl -> w ->

Index: Label.chs
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/gtk/display/Label.chs,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- Label.chs	9 Jul 2003 22:42:43 -0000	1.5
+++ Label.chs	23 May 2004 15:50:26 -0000	1.6
@@ -1,5 +1,5 @@
 -- -*-haskell-*-
---  GIMP Toolkit (GTK) @entry Widget Label@
+--  GIMP Toolkit (GTK) Widget Label
 --
 --  Author : Manuel M. T. Chakravarty,
 --	     Axel Simon
@@ -20,13 +20,8 @@
 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 --  GNU General Public License for more details.
 --
--- @description@ --------------------------------------------------------------
---
---
--- @documentation@ ------------------------------------------------------------
---
+-- |
 --
--- @todo@ ---------------------------------------------------------------------
 
 module Label(
   Label,
@@ -67,7 +62,7 @@
 
 -- methods
 
--- @constructor labelNew@ create a new label widget
+-- | create a new label widget
 --
 labelNew :: Maybe String -> IO Label
 labelNew str = makeNewObject mkLabel $ liftM castPtr $
@@ -75,31 +70,32 @@
     Nothing    -> {#call label_new#} nullPtr
     (Just str) -> withUTFString str {#call label_new#}
 
--- @method labelSetText@ set the text the label widget shows
+-- | set the text the label widget shows
 --
 labelSetText :: LabelClass l => l -> String -> IO ()
 labelSetText l str =
   withUTFString str $ {#call label_set_text#} (toLabel l)
 
--- @method labelSetAttributes@ Set the text attributes.
+{-
+-- | Set the text attributes.
 --
 -- labelSetAttributes :: LabelClass l => PangoAttrList -> IO ()
+-}
 
-
--- @method labelSetMarkup@ set the label to a markup string
+-- | set the label to a markup string
 --
 labelSetMarkup :: LabelClass l => l -> Markup -> IO ()
 labelSetMarkup l str =
   withUTFString str $ {#call label_set_markup#} (toLabel l)
 
--- @method labelSetMarkupWithMnemonic@ set the label to a markup string and
+-- | set the label to a markup string and
 -- interpret keyboard accelerators
 --
 labelSetMarkupWithMnemonic :: LabelClass l => l -> Markup -> IO ()
 labelSetMarkupWithMnemonic l str =
   withUTFString str $ {#call label_set_markup_with_mnemonic#} (toLabel l)
 
--- @method labelSetPattern@ underline parts of the text, odd indices of the
+-- | underline parts of the text, odd indices of the
 -- list represent underlined parts
 --
 labelSetPattern :: LabelClass l => l -> [Int] -> IO ()
@@ -108,18 +104,18 @@
   where
     str = concat $ zipWith replicate list (cycle ['_',' '])
 
--- @method labelSetJustify@ set the justification of the label
+-- | set the justification of the label
 --
 labelSetJustify :: LabelClass l => l -> Justification -> IO ()
 labelSetJustify l j = 
   {#call label_set_justify#} (toLabel l) ((fromIntegral.fromEnum) j)
 
--- @method labelSetLineWrap@ set wether lines should be wrapped or truncated
+-- | set wether lines should be wrapped or truncated
 --
 labelSetLineWrap :: LabelClass l => l -> Bool -> IO ()
 labelSetLineWrap l w = {#call label_set_line_wrap#} (toLabel l) (fromBool w)
 
--- @method labelGetLayoutOffsets@ get starting cooridinates of text rendering
+-- | get starting cooridinates of text rendering
 --
 labelGetLayoutOffsets :: LabelClass l => l -> IO (Int,Int)
 labelGetLayoutOffsets l =
@@ -132,61 +128,61 @@
     )
   )
 
--- @type KeyVal@ KeyVal is a synonym for a hot key number.
+-- | KeyVal is a synonym for a hot key number.
 --
 type KeyVal = {#type guint#}
 
--- @method labelGetMnemonicKeyval@ get the keyval for the underlined character
+-- | get the keyval for the underlined character
 -- in the label
 --
 labelGetMnemonicKeyval :: LabelClass l => l -> IO KeyVal
 labelGetMnemonicKeyval l = 
   {#call unsafe label_get_mnemonic_keyval#} (toLabel l)
 
--- @method labelGetSelectable@ is the text selectable?
+-- | is the text selectable?
 --
 labelGetSelectable :: LabelClass l => l -> IO Bool
 labelGetSelectable l = liftM toBool $ 
   {#call unsafe label_get_selectable#} (toLabel l)
 
--- @method labelGetText@ get the text stored in the label
+-- | get the text stored in the label
 --
 labelGetText :: LabelClass l => l -> IO String
 labelGetText l = {#call unsafe label_get_text#} (toLabel l) >>= peekUTFString
 
 
--- @constructor labelNewWithMnemonic@ Create a new label widget with 
+-- | Create a new label widget with 
 -- accelerator key.
 --
--- * Each underscore in @ref arg str@ is converted into an underlined
+-- * Each underscore in @str@ is converted into an underlined
 --   character in the label. Entering this character will activate the label
---   widget or any other widget set with @ref method labelSetMnemonicWidget@.
+--   widget or any other widget set with 'labelSetMnemonicWidget'.
 --
 labelNewWithMnemonic :: String -> IO Label
 labelNewWithMnemonic str = makeNewObject mkLabel $ liftM castPtr $
   withUTFString str {#call label_new_with_mnemonic#}
 
--- @method labelSelectRegion@ select a region in label
+-- | select a region in label
 --
 labelSelectRegion :: LabelClass l => l -> Int -> Int -> IO ()
 labelSelectRegion l start end = {#call label_select_region#} (toLabel l) 
   (fromIntegral start) (fromIntegral end)
 
 
--- @method labelSetMnemonicWidget@ set an explicit widget for which to emit
+-- | set an explicit widget for which to emit
 -- the mnemonic_activate signal if an underlined character is pressed
 --
 labelSetMnemonicWidget :: (LabelClass l, WidgetClass w) => l -> w -> IO ()
 labelSetMnemonicWidget l w = 
   {#call unsafe label_set_mnemonic_widget#} (toLabel l) (toWidget w)
 
--- @method labelSetSelectable@ make a label text selectable
+-- | make a label text selectable
 --
 labelSetSelectable :: LabelClass l => l -> Bool -> IO ()
 labelSetSelectable l s =
   {#call unsafe label_set_selectable#} (toLabel l) (fromBool s)
 
--- @method labelSetTextWithMnemonic@ set the label to a markup string and
+-- | set the label to a markup string and
 -- interpret keyboard accelerators
 --
 labelSetTextWithMnemonic :: LabelClass l => l -> String -> IO ()

[Gtk2hs-commit] gtk2hs ChangeLog,1.155,1.156

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

Update of /cvsroot/gtk2hs/gtk2hs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13363

Modified Files:
	ChangeLog 
Log Message:
initial haddockification


Index: ChangeLog
===================================================================
RCS file: /cvsroot/gtk2hs/gtk2hs/ChangeLog,v
retrieving revision 1.155
retrieving revision 1.156
diff -u -d -r1.155 -r1.156
--- ChangeLog	23 May 2004 15:48:35 -0000	1.155
+++ ChangeLog	23 May 2004 15:50:27 -0000	1.156
@@ -12,6 +12,10 @@
 	gtk/buttons/RadioButton.chs, gtk/buttons/ToggleButton.chs:
 	initial haddockification
 
+	* gtk/display/AccelLabel.chs, gtk/display/Image.chs,
+	gtk/display/Label.chs, gtk/display/ProgressBar.chs,
+	gtk/display/Statusbar.chs: initial haddockification
+
 2004-05-21 Duncan Coutts <du...@co...>
 
 	* gtk/abstract/FileChooser.chs, gtk/abstract/Widget.chs: