TouchInstinct
/
checkstyle
311
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Corrected javadoc/xdoc for IllegalTypeCheck

This commit is contained in:
Andrei Selkin 2015-09-02 01:14:25 +03:00 committed by Roman Ivanov
parent 8607274a92
commit 6f7dfc3c69
2 changed files with 5 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTypeCheck.java
View File

@ -34,13 +34,10 @@ import com.puppycrawl.tools.checkstyle.utils.TokenUtils;
/**
* Checks that particular class are never used as types in variable
* declarations, return values or parameters. Includes
* a pattern check that by default disallows abstract classes.
* declarations, return values or parameters.
*
* <p>Rationale:
* Helps reduce coupling on concrete classes. In addition abstract
* classes should be thought of a convenience base class
* implementations of interfaces and as such are not types themselves.
* Helps reduce coupling on concrete classes.
*
* <p>Check has following properties:
*
@ -90,6 +87,7 @@ import com.puppycrawl.tools.checkstyle.utils.TokenUtils;
*
* @author <a href="mailto:simon@redhillconsulting.com.au">Simon Harris</a>
* @author <a href="mailto:nesterenko-aleksey@list.ru">Aleksey Nesterenko</a>
* @author <a href="mailto:andreyselkin@gmail.com">Andrei Selkin</a>
*/
public final class IllegalTypeCheck extends AbstractFormatCheck {

7
src/xdocs/config_coding.xml
View File

@ -1924,14 +1924,11 @@ if (&quot;something&quot;.equals(x))
<subsection name="Description">
<p>
Checks that particular classes are never used as types in variable
declarations, return values or parameters. Includes a pattern check
that by default disallows abstract classes.
declarations, return values or parameters.
</p>
<p>
Rationale: Helps reduce coupling on concrete classes. In addition
abstract classes should be thought of as convenient base class
implementations of interfaces, and as such, are not types themselves.
Rationale: Helps reduce coupling on concrete classes.
</p>
</subsection>