https://github.com/bergmark/mmdoc

Rudimentary parser for a subset of MetaModelica for generating documentation, written in Haskell
https://github.com/bergmark/mmdoc

Last synced: 25 days ago
JSON representation

Rudimentary parser for a subset of MetaModelica for generating documentation, written in Haskell

• Host: GitHub
• URL: https://github.com/bergmark/mmdoc
• Owner: bergmark
• License: bsd-3-clause
• Created: 2012-09-30T02:16:35.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2013-05-18T21:43:57.000Z (over 11 years ago)
• Last Synced: 2023-03-10T22:13:58.553Z (over 1 year ago)
• Language: Haskell
• Size: 402 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mmdoc

A simplistic parser for MetaModelica written in Haskell with the

purpose of retrieving the necessary information for generating

documentation.

It only parses a subset of MetaModelica, and hence a subset of

Modelica and does not handle non-functional parts. The result is a

simplified AST.

Do not try to use this parser to check the validity of your

program. It is meant to run only on source files that `omc` accepts.

## Notable omissions

* Loops, use recursion

* Type variables in uniontypes and records of the form `uniontype U`

  or `record R`. Using these with concrete types are problematic.

  Use `replaceable type`s instead.


* `model` and `class`, use functions only

* Statements and expressions are parsed, but only the bare minimum to

  proceed with the rest of the parsing so their representation may not

  be very useful.

## TODO

### Parsing

* `match` guards

* Better identification of documentation strings