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
	1 Introduction	↓
	1.1 Principles	--
	1.1.1 Writing API Specifications	???
	1.1.1.1 Separate Specification Documents	???
	1.1.1.2 Contract Between Callers and Implementations	???
	1.1.1.3 Implementation-Independent Assertions	???
	1.1.1.4 Conformance Testing Requirements	???
	1.1.2 Writing Programming Guide Documentation	???
	1.1.2.1 API spec bugs	???
	1.1.2.2 Code bugs	???
	1.1.3 Who Owns and Edits the Doc Comments	--
	1.2 Terminology	--
	1.3 Source Files	--
	2 Writing Doc Comments	↓
	2.1 Format of a Doc Comment	???
	2.1.1 Notes	???
	2.1.2 getImage	--
	2.2 Doc Comment Checking Tool	--
	2.3 Descriptions	↓
	2.3.1 First Sentence	???
	2.3.2 Implementation-Independence	???
	2.3.3 Automatic re-use of method comments	???
	2.4 A Style Guide	↓
	2.4.1 <code> style for keywords and names	???
	2.4.2 In-line links	???
	2.4.3 Method and constructor parentheses	???
	2.4.4 Phrases instead of sentences	???
	2.4.5 Third-person descriptions	???
	2.4.6 Method descriptions	???
	2.4.7 Class, interface, and field descriptions	???
	2.4.8 Use of “this”	???
	2.4.9 Description beyond API name	???
	2.4.10 Use of “field”	???
	2.4.11 Latin terms	???
	2.5 Tag Conventions	↓
	2.5.1 Order of Tags	AtclauseOrder ( config)	samples
	2.5.2 Ordering Multiple Tags	???
	2.5.3 Required Tags	???
	2.5.4 Tag Comments	↓
	2.5.4.1 @author	???
	2.5.4.2 @version	???
	2.5.4.3 @param	???
	2.5.4.4 @return	???
	2.5.4.5 @deprecated	???
	2.5.4.6 @since	???
	2.5.4.7 @throws	???
	2.5.4.8 @see	???
	2.5.4.9 @serial	???
	2.5.4.10 @serialField	???
	2.5.4.11 @serialData	???
	2.5.4.12 {@link}	???
	2.5.5 Custom Tags and Annotations	???
	2.6 Documenting Default Constructors	???
	2.7 Documenting Exceptions with @throws Tag	--
	2.7.1 Documenting Exceptions in API Specs	--
	2.7.2 Throws Tag	--
	2.7.3 Exceptions to Document	???
	2.7.4 Documenting Unchecked Exceptions	???
	2.7.5 Background on Checked and Unchecked Exceptions	--
	2.7.6 Background on the Throws Clause	???
	2.8 Package-Level Comments	--
	2.8.1 Template for package.html	???
	2.8.2 Contents of package.html	???
	2.9 Documenting Anonymous Inner Classes	--
	2.10 Including Images	--
	2.10.1 Images in Source Tree	↓
	2.10.1.1 Naming of doc images in source tree	???
	2.10.1.2 Location of doc images in source tree	???
	2.10.2 Images in HTML Destination	↓
	2.10.2.1 Naming of doc images in HTML destination	???
	2.10.2.2 Location of doc images in HTML destination	???
	2.11 Examples of Doc Comments	--
	2.12 Troubleshooting Curly Quotes (Microsoft Word)	--