[jira] [Created] (OFBIZ-11941) Checkstyle: Add override property in DesignForExtension module

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Created] (OFBIZ-11941) Checkstyle: Add override property in DesignForExtension module

Nicolas Malin (Jira)
Suraj Khurana created OFBIZ-11941:
-------------------------------------

             Summary: Checkstyle: Add override property in DesignForExtension module
                 Key: OFBIZ-11941
                 URL: https://issues.apache.org/jira/browse/OFBIZ-11941
             Project: OFBiz
          Issue Type: Sub-task
          Components: ALL COMPONENTS
    Affects Versions: Trunk
            Reporter: Suraj Khurana
            Assignee: Suraj Khurana


While performing checks for class design it is mandatory to provide javadoc, we can skip override methods from this checkstyle check.

Sample error:
Class 'ABC' looks like designed for extension (can be subclassed), but the method 'xyz' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ABC' final or making the method 'xyz' static/final/abstract/empty, or adding allowed annotation for the method.



<module name="DesignForExtension">
 <property name="ignoredAnnotations"
 value="After, AfterClass, Before, BeforeClass, Test, Property, *Override*"/>
</module>



--
This message was sent by Atlassian Jira
(v8.3.4#803005)