For example,
should turn into
/*xml
<module name="Checker">
<module name="TreeWalker">
<module name="AbstractClassName"/>
</module>
</module>
*/
package com.puppycrawl.tools.checkstyle.checks.naming.abstractclassname;
// xdoc section -- start
class Test1{
abstract class AbstractFirstClass {} // OK
abstract class SecondClass {} // violation
class AbstractThirdClass {} // violation
class FourthClass {} // OK
}
// xdoc section -- end
Edit: As time progressed since this issue was created, a few things changed. Example configurations should be in XML (as shown above) and the code should have delimiters surrounding the class definition. Moreover, examples will be excluded from xdoc-javadoc validation. When this issue is closed, there will be a list of all modules below in XdocsJavadocsTest. This list can be removed along with the if-statements using it.
For convenience, this issue takes care of multiple things - moving examples to test files, placing macros in place of the examples, adding id to each example, and removing examples from class javadoc.
Filters:
For example,
should turn into
Edit: As time progressed since this issue was created, a few things changed. Example configurations should be in XML (as shown above) and the code should have delimiters surrounding the class definition. Moreover, examples will be excluded from xdoc-javadoc validation. When this issue is closed, there will be a list of all modules below in
XdocsJavadocsTest. This list can be removed along with theif-statements using it.For convenience, this issue takes care of multiple things - moving examples to test files, placing macros in place of the examples, adding id to each example, and removing examples from class javadoc.
Filters: