2019-06-07 23:28:03 +00:00
|
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
|
|
|
<!DOCTYPE suppressions PUBLIC
|
|
|
|
|
"-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
|
|
|
|
|
"https://checkstyle.org/dtds/suppressions_1_2.dtd">
|
|
|
|
|
<suppressions>
|
|
|
|
|
<!-- All the config options and method fields. -->
|
|
|
|
|
<suppress checks="StaticVariableName" files=".*[\\/]ComputerCraft.java" />
|
|
|
|
|
<suppress checks="StaticVariableName" files=".*[\\/]ComputerCraftAPI.java" />
|
2019-10-27 15:16:47 +00:00
|
|
|
|
|
|
|
|
<!-- Do not check for missing package Javadoc. -->
|
|
|
|
|
<suppress checks="JavadocStyle" files=".*[\\/]package-info.java" />
|
Generate documentation stubs from Javadocs
illuaminate does not handle Java files, for obvious reasons. In order to
get around that, we have a series of stub files within /doc/stub which
mirrored the Java ones. While this works, it has a few problems:
- The link to source code does not work - it just links to the stub
file.
- There's no guarantee that documentation remains consistent with the
Java code. This change found several methods which were incorrectly
documented beforehand.
We now replace this with a custom Java doclet[1], which extracts doc
comments from @LuaFunction annotated methods and generates stub-files
from them. These also contain a @source annotation, which allows us to
correctly link them back to the original Java code.
There's some issues with this which have yet to be fixed. However, I
don't think any of them are major blockers right now:
- The custom doclet relies on Java 9 - I think it's /technically/
possible to do this on Java 8, but the API is significantly uglier.
This means that we need to run javadoc on a separate JVM.
This is possible, and it works locally and on CI, but is definitely
not a nice approach.
- illuaminate now requires the doc stubs to be generated in order for
the linter to pass, which does make running the linter locally much
harder (especially given the above bullet point).
We could notionally include the generated stubs (or at least a cut
down version of them) in the repo, but I'm not 100% sure about that.
[1]: https://docs.oracle.com/javase/9/docs/api/jdk/javadoc/doclet/package-summary.html
2020-07-03 12:31:26 +00:00
|
|
|
|
|
|
|
|
<!-- The commands API is documented in Lua. -->
|
|
|
|
|
<suppress checks="SummaryJavadocCheck" files=".*[\\/]CommandAPI.java" />
|
2019-06-07 23:28:03 +00:00
|
|
|
</suppressions>
|