From: Duncan C. <dun...@us...> - 2004-05-23 16:01:06
|
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 = |