summaryrefslogtreecommitdiff
path: root/src/compiler/GF/Compile.hs
diff options
context:
space:
mode:
authorhallgren <hallgren@chalmers.se>2014-10-20 19:45:43 +0000
committerhallgren <hallgren@chalmers.se>2014-10-20 19:45:43 +0000
commita9bc1160521a0196ab8407a565b7643fe649f6f6 (patch)
tree12f67936bec7e99800cfbefbe5145df2b42e0d29 /src/compiler/GF/Compile.hs
parent8337a19b40301bfda5dd74c6d975072f168538de (diff)
Some small documentation improvements
Diffstat (limited to 'src/compiler/GF/Compile.hs')
-rw-r--r--src/compiler/GF/Compile.hs3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/compiler/GF/Compile.hs b/src/compiler/GF/Compile.hs
index fb37cd1fe..2eed7a6ff 100644
--- a/src/compiler/GF/Compile.hs
+++ b/src/compiler/GF/Compile.hs
@@ -30,6 +30,8 @@ import PGF(PGF,defaultProbabilities,setProbabilities,readProbabilitiesFromFile)
compileToPGF :: Options -> [FilePath] -> IOE PGF
compileToPGF opts fs = link opts =<< batchCompile opts fs
+-- | Link a grammar into a 'PGF' that can be used to 'PGF.linearize' and
+-- 'PGF.parse' with the "PGF" run-time system.
link :: Options -> (Ident,t,SourceGrammar) -> IOE PGF
link opts (cnc,_,gr) =
putPointE Normal opts "linking ... " $ do
@@ -40,6 +42,7 @@ link opts (cnc,_,gr) =
return $ setProbabilities probs
$ if flag optOptimizePGF opts then optimizePGF pgf else pgf
+-- | Returns the name of the abstract syntax corresponding to the named concrete syntax
srcAbsName gr cnc = err (const cnc) id $ abstractOfConcrete gr cnc
-- | Compile the given grammar files and everything they depend on