Useful information

This coverage report was created for Documentation Comments Style (cached page),

Checkstyle configuration for 'Documentation Comments Style'

Legend

"???" - Report is incomplete in this line.
"--" - There is no rule in this paragraph.
"↓" - This paragraph is the high-level point of some group.
- Existing Check covers all requirements.
- Existing Check covers some part of requirements.
- Requirements are not possible to check by Checkstyle at all.

Coverage table

ATTENTION: Links to config and sample files in the following table reference to latest (not released yet) config. Config might be slightly different from what we have in the latest release. Please always use config that is embedded to jar or use a custom version copied from one that matches your checkstyle version.

	Documentation Comments Rule	Checkstyle Checks Used	Sample files
	Introduction	↓
	Principles	--
	Writing API Specifications	???
	Java Platform API Specification is defined by the documentation comments in the source code	???
	Java Platform API Specification is a contract between callers and implementations	???
	Java API Specification assertions need to be implementation-independent	???
	Java API Specification should contain assertions sufficient to enable Software Quality Assurance	???
	Writing Programming Guide Documentation	???
	API spec bugs	???
	Code bugs	???
	Who Owns and Edits the Doc Comments	--
	Terminology	--
	Source Files	--
	Writing Doc Comments	↓
	Format of a Doc Comment	???
	Notes	???
	getImage	--
	Doc Comment Checking Tool	--
	Descriptions	↓
	First Sentence	???
	Implementation-Independence	???
	Automatic re-use of method comments	???
	A Style Guide	↓
	Use <code> style for keywords and names	???
	Use in-line links economically	???
	Omit parentheses for the general form of methods and constructors	???
	OK to use phrases instead of complete sentences	???
	Use 3rd person descriptive	???
	Method descriptions begin with a verb phrase	???
	Class/interface/field descriptions can omit the subject and simply state the object	???
	Use "this" instead of "the" when referring to an object created from the current class	???
	Add description beyond the API name	???
	Be clear when using the term "field"	???
	Avoid Latin	???
	Tag Conventions	↓
	Order of Tags	AtclauseOrder ( config)	samples
	Ordering Multiple Tags	???
	Required Tags	???
	Tag Comments	↓
	@author	--
	@version	???
	@param	???
	@return	???
	@deprecated	???
	@since	???
	@throws	???
	@see	???
	@serial	???
	@serialField	???
	@serialData	???
	{@link}	???
	Custom Tags and Annotations	???
	Documenting Default Constructors	???
	Documenting Exceptions with @throws Tag	--
	Documenting Exceptions in API Specs	--
	Throws Tag	--
	Guidelines - Which Exceptions to Document	???
	Documenting Unchecked Exceptions	???
	Background on Checked and Unchecked Exceptions	--
	Background on the Throws Clause	???
	Package-Level Comments	--
	Template for package.html source file	???
	Contents of package.html source file	???
	Documenting Anonymous Inner Classes	--
	Including Images	--
	Images in Source Tree	↓
	Naming of doc images in source tree	???
	Location of doc images in source tree	???
	Images in HTML Destination	↓
	Naming of doc images in HTML destination	--
	Location of doc images in HTML destination	--
	Examples of Doc Comments	--
	Troubleshooting Curly Quotes (Microsoft Word)	--