Documentation

[rodinaarssen]

The documentation of ClaiR can be improved, for example:

• document how to configure a client project (set dependencies in MANIFEST.MF, RASCAL.MF, etc)
• document how to use ClaiR from the command line/outside Eclipse
• properly document interface methods
• provide some examples

[linuswagner]

I agree. For example, it is unclear for me what the difference between createM3AndAstFromCppFile and parseCppToM3AndAst.

Looking at the signatures

tuple[M3, Declaration] createM3AndAstFromCppFile(loc file, list[loc] stdLib = classPaths["vs12"], list[loc] includeDirs = [], map[str,str] additionalMacros = (), bool includeStdLib = false)
tuple[M3, Declaration] parseCppToM3AndAst       (loc file, list[loc] stdLib = classPaths["vs12"], list[loc] includeDirs = [], map[str,str] additionalMacros = (), bool includeStdLib = false)

(spaces added for better comparability) they are essentially identical, which is highly confusing. I'd expect that they essentially behave the same, because creating a M3 and AST from a file also requires parsing.