From fef4d56e7106fcbe7bde52afa2016a71d3a544e6 Mon Sep 17 00:00:00 2001
From: bringert <bringert@cs.chalmers.se>
Date: Mon, 29 Jan 2007 12:20:31 +0000
Subject: [PATCH] Document CFTerm constructors.

---
 src/GF/Speech/TransformCFG.hs | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/GF/Speech/TransformCFG.hs b/src/GF/Speech/TransformCFG.hs
index bb6f16243..300f9654f 100644
--- a/src/GF/Speech/TransformCFG.hs
+++ b/src/GF/Speech/TransformCFG.hs
@@ -53,13 +53,13 @@ import qualified Data.Set as Set
 type CFRule_ = CFRule Cat_ CFTerm Token
 
 data CFTerm
-    = CFObj Fun [CFTerm]
-    | CFAbs Int CFTerm
-    | CFApp CFTerm CFTerm
-    | CFRes Int
-    | CFVar Int
-    | CFConst String
-    | CFMeta String
+    = CFObj Fun [CFTerm] -- ^ an abstract syntax function with arguments
+    | CFAbs Int CFTerm -- ^ A lambda abstraction. The Int is the variable id.
+    | CFApp CFTerm CFTerm -- ^ Application
+    | CFRes Int -- ^ The result of the n:th non-terminal
+    | CFVar Int -- ^ A lambda-bound variable
+    | CFConst String 
+    | CFMeta String -- ^ A metavariable
   deriving (Eq,Ord,Show)
 
 type Cat_ = String