mirror of
https://github.com/SpaceManiac/SpacemanDMM.git
synced 2025-12-23 05:36:47 +00:00
Add a readme for the dreammaker crate
This commit is contained in:
parent
30b78983d0
commit
2f4ed73d94
3 changed files with 23 additions and 11 deletions
|
|
@ -22,7 +22,7 @@ diagnostics, making it suitable for use in continuous integration environments.
|
|||
In addition to the simple inline diagnostics discovered by the [parsing suite],
|
||||
DreamCheckers's whole-program analysis can find problems such as:
|
||||
|
||||
[parsing suite]: ../dreammaker/
|
||||
[parsing suite]: ../dreammaker/#diagnostics
|
||||
|
||||
* Unknown `set` setting names.
|
||||
* Undefined types on unused variables.
|
||||
|
|
|
|||
18
src/dreammaker/README.md
Normal file
18
src/dreammaker/README.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
# `dreammaker` library
|
||||
|
||||
This library crate implements a parser for the DreamMaker language. It is a
|
||||
core component of SpacemanDMM and powers the rest of the tooling.
|
||||
|
||||
## Diagnostics
|
||||
|
||||
* Preprocessor:
|
||||
* Redefining a macro which is already defined.
|
||||
* Undefining a macro which is not defined.
|
||||
* Unterminated conditional blocks (`#if`/`#ifdef`).
|
||||
* Using a define in a [buggy context][2072419].
|
||||
* Language:
|
||||
* Incorrect or correct-but-strange syntax.
|
||||
* Non-constant initial values for object variables.
|
||||
* Integer constants which are outside of range.
|
||||
|
||||
[2072419]: https://secure.byond.com/forum/?post=2072419
|
||||
|
|
@ -47,17 +47,11 @@ client support.
|
|||
|
||||
## Diagnostics
|
||||
|
||||
* Preprocessor:
|
||||
* Redefining a macro which is already defined.
|
||||
* Undefining a macro which is not defined.
|
||||
* Unterminated conditional blocks (`#if`/`#ifdef`).
|
||||
* Using a define in a [buggy context][2072419].
|
||||
* Language:
|
||||
* Incorrect or correct-but-strange syntax.
|
||||
* Non-constant initial values for object variables.
|
||||
* Integer constants which are outside of range.
|
||||
* All [parsing suite] diagnostics.
|
||||
* Optional [DreamChecker] diagnostics.
|
||||
|
||||
[2072419]: https://secure.byond.com/forum/?post=2072419
|
||||
[parsing suite]: ../dreammaker/#diagnostics
|
||||
[DreamChecker]: ../dreamchecker/#diagnostics
|
||||
|
||||
## Signature help
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue