Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #22

Open
rodinaarssen opened this issue Mar 26, 2021 · 1 comment
Open

Documentation #22

rodinaarssen opened this issue Mar 26, 2021 · 1 comment

Comments

@rodinaarssen
Copy link
Member

rodinaarssen commented Mar 26, 2021

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
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants