Package com.google.errorprone.bugpatterns.javadoc

package com.google.errorprone.bugpatterns.javadoc

Related Packages

Package	Description
com.google.errorprone.bugpatterns	Checks added to the java compiler which detect common bug patterns.

Classes

Class	Description
AlmostJavadoc	Flags comments which appear to be intended to be Javadoc, but are not started with an extra *.
EmptyBlockTag	Matches block tags (@param, @return, @throws, @deprecated) with an empty description.
EscapedEntity	Finds unescaped entities in Javadocs.
InheritDoc	Matches invalid usage of @inheritDoc.
InvalidBlockTag	Matches invalid Javadoc tags, and tries to suggest fixes.
InvalidInlineTag	Matches invalid Javadoc tags, and tries to suggest fixes.
InvalidLink	Finds some common errors in @link tags.
InvalidParam	Matches incorrect Javadoc @param tags.
InvalidSnippet	A bug pattern; see the summary.
InvalidThrows	Matches errors in Javadoc @throws tags.
InvalidThrowsLink	Matches misuse of link tags within throws tags.
KnownTags	Other commonly-used javadoc tags which we allow.
MalformedInlineTag	Finds malformed inline tags where @{tag is used instead of {@tag.
MissingJavadoc	A BugChecker; see the associated BugPattern annotation for details.
MissingSummary	Matches Javadocs which are missing a required summary line.
NotJavadoc	A BugPattern; see the summary.
PreferThrowsTag	Prefer the @throws tag instead of the @exception tag.
ReturnFromVoid	Finds common Javadoc errors, and tries to suggest useful fixes.
TraditionalJavadocToMarkdown	An experimental tool that converts traditional Javadoc comments to Markdown Javadoc comments.
UnescapedEntity	Finds unescaped entities in Javadocs.
UnrecognisedJavadocTag	Flags tags which haven't been recognised by the Javadoc parser.
UrlInSee	Discourages using URLs in @see tags.