doc: Known API issues was added to reference #3810

This commit is contained in:
Roman Ivanov 2017-02-09 06:51:36 -08:00
parent 8c0e0d0035
commit 837ae3bbb0
1 changed files with 4 additions and 0 deletions

View File

@ -556,6 +556,10 @@ java -cp checkstyle-${projectVersion}-all.jar com.puppycrawl.tools.checkstyle.gu
See <a href="writingchecks.html#Declare_checks_external_resource_locations">Declare check's external resource locations</a>.
</section>
<section name="Known API issues">
<a href="https://github.com/checkstyle/checkstyle/issues/3810">JvadocParser: inconsistent AST tree with and without SINGLETON_ELEMENT #3810</a>.
</section>
<section name="Examples of Javadoc Checks">
The best source knowledge about how to write Javadoc Checks
could be taken from