fix Haddock documentation, contrinutes to #8

This commit is contained in:
Trolli Schmittlauch 2020-03-04 12:39:19 +01:00
parent 08932cf80a
commit 3b3ee09575

View file

@ -68,6 +68,7 @@ instance Ord NodeID where
wayForwards = getNodeID (b - a) wayForwards = getNodeID (b - a)
wayBackwards = getNodeID (a - b) wayBackwards = getNodeID (a - b)
-- | represents a node and all its important state
data NodeState = NodeState { data NodeState = NodeState {
id :: NodeID id :: NodeID
, domain :: String , domain :: String
@ -98,9 +99,10 @@ data NodeState = NodeState {
} }
-- |an entry of the 'nodeCache' -- |an entry of the 'nodeCache'
type CacheEntry = (NodeState -- ^a node's data type CacheEntry = (
, SystemTime -- ^timestamp for cache entry expiration NodeState
) , SystemTime
) -- ^ ( a node's data, timestamp for cache entry expiration )
-- Todo: DHT backend can learn potential initial bootstrapping points through the instances mentioned in the received AP-relay messages -- Todo: DHT backend can learn potential initial bootstrapping points through the instances mentioned in the received AP-relay messages
-- needs to know its own domain anyways for ID generation -- needs to know its own domain anyways for ID generation