Haddock documentation
Wed Mar 29 09:30:57 WEST 2006 Miguel Vilaca <jmvilaca@di.uminho.pt>
* Haddock documentation
{
adddir ./docs
adddir ./docs/haddock
hunk ./Makefile 51
+DOCS = docs/haddock
hunk ./Makefile 53
-# Documentation target (use Haddock 0.5 in combination with GHC 6.0.1)[_^I_][_$_]
+# Documentation target (use Haddock 0.7 in combination with GHC 6.4)[_^I_][_$_]
hunk ./Makefile 55
+ ghc -cpp -E -optP-P -D__HADDOCK__ src/NetworkUI.hs -o src/NetworkUI.hspp
+ ghc -cpp -E -optP-P -D__HADDOCK__ lib/DData/IntMap.hs -o lib/DData/IntMap.hspp
hunk ./Makefile 58
- -h -o docs/haddock \
- --lib C:\cygwin\home\administrator\haddock-0.5\haddock\html \
- $(BLOBS)
+ -h -o $(DOCS) \
+ --lib /usr/local/share/haddock-0.7 \
+ --use-package=wx --use-package=HaXml \
+ $(filter-out src/NetworkUI.hs, $(INBLOBS)) src/NetworkUI.hspp \
+ lib/DData/IntMap.hspp \
+
+# Clean documentation files
+cleandoc:
+ $(RM) $(DOCS)/*
hunk ./src/INTextual.hs 28
-type Agent = (AgentName -- ^
- , Int -- ^ the agent arity, this is, the number of ports
+type Agent = (AgentName -- agent name
+ , Int -- the agent arity, this is, the number of ports
hunk ./src/INTextual.hs 276
- -- Now it simply transverse the all tree and replaces in the correct place.
+ -- Now it simply transverse the whole tree and replaces in the correct place.
hunk ./src/INTextual.hs 284
- -- | Substitution in terms; t[rhs/x] [_$_]
+ -- | Substitution in terms; t[rhs\/x] [_$_]
hunk ./src/INTextual.hs 287
- -- is replaced by term @ rhs @
+ -- is replaced by term @ rhs @.
hunk ./src/INTextualUI.hs 17
--- Generate textual descrition
+-- Generate textual description
hunk ./src/Network.hs 13
-
+ -- ** Set\'s e get\'s
hunk ./src/Network.hs 19
-
+ -- ** Get usefull information from 'Network'
hunk ./src/Network.hs 27
-
+ -- ** Search\'s
hunk ./src/Network.hs 32
-
+ -- ** update network elements
hunk ./src/Network.hs 38
-
+ -- ** add and remove network elements
hunk ./src/Network.hs 44
+ -- * Node
hunk ./src/Network.hs 46
+ -- ** get and set node data in a network by 'NodeNr' [_$_]
hunk ./src/Network.hs 49
+ -- ** get\'s and set\'s of a node
hunk ./src/Network.hs 52
-
+ -- * Edge
hunk ./src/Network.hs 56
-
+ -- * Interaction Nets functionality
hunk ./src/NetworkControl.hs 20
-{- | pickupX functions with X belonging to {Node, Edge, Via, Area, Multiple} do
+{- pickupX functions with X belonging to {Node, Edge, Via, Area, Multiple} do
hunk ./src/NetworkUI.hs 66
-{-^ Containment structure of widgets: [_$_]
+{- Containment structure of widgets: [_$_]
hunk ./src/NetworkUI.hs 728
- -- the shape name of the first palette element is choosed
+ -- the shape name of the first palette's element is chosen
hunk ./src/NetworkUI.hs 1000
- do -- adds an inicial rule
+ do -- adds an initial rule
hunk ./src/XTC.hs 20
-module XTC ( Labeled( toLabel ),
- , TValued( tValue ),
- , TItems( tItems ),
- , TSelection( tSelection ),
- , TSelections( tSelections ),
+module XTC ( Labeled( toLabel )
+ , TValued( tValue )
+ , TItems( tItems )
+ , TSelection( tSelection )
+ , TSelections( tSelections )
}