[jira] [Created] (OFBIZ-11947) Checkstyle: Add Javadoc for classes designed for extension

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

[jira] [Created] (OFBIZ-11947) Checkstyle: Add Javadoc for classes designed for extension

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

             Summary: Checkstyle: Add Javadoc for classes designed for extension
                 Key: OFBIZ-11947
                 URL: https://issues.apache.org/jira/browse/OFBIZ-11947
             Project: OFBiz
          Issue Type: Sub-task
          Components: ALL COMPONENTS
    Affects Versions: Trunk
            Reporter: Suraj Khurana
            Assignee: Suraj Khurana


For checkstyle errors:

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

We need to add missing javadocs for all such methods



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