diff --git a/src/dreamchecker/README.md b/src/dreamchecker/README.md index de22d016..3b3d55e2 100644 --- a/src/dreamchecker/README.md +++ b/src/dreamchecker/README.md @@ -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. diff --git a/src/dreammaker/README.md b/src/dreammaker/README.md new file mode 100644 index 00000000..93ddb33b --- /dev/null +++ b/src/dreammaker/README.md @@ -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 \ No newline at end of file diff --git a/src/langserver/README.md b/src/langserver/README.md index a049e0c2..52ba590b 100644 --- a/src/langserver/README.md +++ b/src/langserver/README.md @@ -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