From 150940b8704a6a61ed08c6bbd99ba4b05a42c59c Mon Sep 17 00:00:00 2001
From: krasimir <krasimir@chalmers.se>
Date: Fri, 30 May 2008 13:07:11 +0000
Subject: cleaned up and documented PGF API

---
 src-3.0/PGF/CId.hs | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src-3.0/PGF/CId.hs')

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
-- 
cgit v1.2.3