Package com.google.errorprone.bugpatterns.javadoc
package com.google.errorprone.bugpatterns.javadoc
-
ClassDescriptionFlags comments which appear to be intended to be Javadoc, but are not started with an extra
*
.Matches block tags (@param, @return, @throws, @deprecated) with an empty description.Finds unescaped entities in Javadocs.Matches invalid usage of @inheritDoc.Matches invalid Javadoc tags, and tries to suggest fixes.Matches invalid Javadoc tags, and tries to suggest fixes.Finds some common errors in @link tags.Matches incorrect Javadoc @param tags.Matches errors in Javadoc @throws tags.Matches misuse of link tags within throws tags.Finds malformed inline tags where @{tag is used instead of {@tag.Matches Javadocs which are missing a required summary line.A BugPattern; see the summary.Finds common Javadoc errors, and tries to suggest useful fixes.Finds unescaped entities in Javadocs.Flags tags which haven't been recognised by the Javadoc parser.Discourages using URLs in @see tags.