diff options
| author | hallgren <hallgren@chalmers.se> | 2014-10-20 19:45:43 +0000 |
|---|---|---|
| committer | hallgren <hallgren@chalmers.se> | 2014-10-20 19:45:43 +0000 |
| commit | a9bc1160521a0196ab8407a565b7643fe649f6f6 (patch) | |
| tree | 12f67936bec7e99800cfbefbe5145df2b42e0d29 /src | |
| parent | 8337a19b40301bfda5dd74c6d975072f168538de (diff) | |
Some small documentation improvements
Diffstat (limited to 'src')
| -rw-r--r-- | src/compiler/GF.hs | 10 | ||||
| -rw-r--r-- | src/compiler/GF/Compile.hs | 3 | ||||
| -rw-r--r-- | src/compiler/GF/Main.hs | 1 |
3 files changed, 12 insertions, 2 deletions
diff --git a/src/compiler/GF.hs b/src/compiler/GF.hs index 64c3184c6..dd5cc8b31 100644 --- a/src/compiler/GF.hs +++ b/src/compiler/GF.hs @@ -9,18 +9,22 @@ module GF( module GF.CompileInParallel, module GF.CompileOne, - -- * Abstract syntax, parsing and pretty printing + -- * Abstract syntax, parsing, pretty printing and serialisation module GF.Compile.GetGrammar, module GF.Grammar.Grammar, module GF.Grammar.Macros, module GF.Grammar.Printer, module GF.Infra.Ident, + -- ** Binary serialisation + module GF.Grammar.Binary, -- * Supporting infrastructure and system utilities module GF.Data.Operations, module GF.Infra.UseIO, module GF.Infra.Option, - module GF.System.Console + module GF.System.Console, + -- ** Binary serialisation + Binary,encode,decode,encodeFile,decodeFile ) where import GF.Main import GF.Compiler @@ -35,8 +39,10 @@ import GF.Grammar.Grammar import GF.Grammar.Macros import GF.Grammar.Printer import GF.Infra.Ident +import GF.Grammar.Binary import GF.Data.Operations import GF.Infra.Option import GF.Infra.UseIO import GF.System.Console +import Data.Binary
\ No newline at end of file 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 diff --git a/src/compiler/GF/Main.hs b/src/compiler/GF/Main.hs index c7656248f..1679c376c 100644 --- a/src/compiler/GF/Main.hs +++ b/src/compiler/GF/Main.hs @@ -23,6 +23,7 @@ main = do uncurry mainOpts =<< getOptions -- | Get and parse GF command line arguments. Fix relative paths. +-- Calls 'getArgs' and 'parseOptions'. getOptions = do args <- getArgs case parseOptions args of |
