summaryrefslogtreecommitdiff
path: root/src-3.0/PGF/CId.hs
diff options
context:
space:
mode:
authorkrasimir <krasimir@chalmers.se>2008-05-30 13:07:11 +0000
committerkrasimir <krasimir@chalmers.se>2008-05-30 13:07:11 +0000
commit150940b8704a6a61ed08c6bbd99ba4b05a42c59c (patch)
tree277a97a4a3ba770e49e51a5526cf2e46bc2c6e1a /src-3.0/PGF/CId.hs
parent8bb0c32a9cf2cbad0375ab5886b7f2be37109477 (diff)
cleaned up and documented PGF API
Diffstat (limited to 'src-3.0/PGF/CId.hs')
-rw-r--r--src-3.0/PGF/CId.hs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src-3.0/PGF/CId.hs b/src-3.0/PGF/CId.hs
index 8853d3d5b..161529308 100644
--- a/src-3.0/PGF/CId.hs
+++ b/src-3.0/PGF/CId.hs
@@ -2,13 +2,17 @@ module PGF.CId (CId(..), wildCId, mkCId, prCId) where
import Data.ByteString.Char8 as BS
+-- | An abstract data type that represents
+-- function identifier in PGF.
newtype CId = CId BS.ByteString deriving (Eq,Ord,Show)
wildCId :: CId
wildCId = CId (BS.singleton '_')
+-- | Creates a new identifier from 'String'
mkCId :: String -> CId
mkCId s = CId (BS.pack s)
+-- | Renders the identifier as 'String'
prCId :: CId -> String
prCId (CId x) = BS.unpack x