[
https://issues.apache.org/jira/browse/OFBIZ-11947?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17178778#comment-17178778 ]
ASF subversion and git services commented on OFBIZ-11947:
---------------------------------------------------------
Commit 8c10d4ae724dd06fc0e2003ad49a5b90ad86eea2 in ofbiz-framework's branch refs/heads/trunk from Suraj Khurana
[
https://gitbox.apache.org/repos/asf?p=ofbiz-framework.git;h=8c10d4a ]
Improved: Added missing Javadocs for some methods, this is required for all classes which looks like designed for extension (can be subclassed).
(OFBIZ-11947)
This is done for framework component. Also corrected some variables as per naming convention best practices.
Thanks Jacques for review.
> 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
> Priority: Major
> Attachments: OFBIZ-11947-plugins.patch, OFBIZ-11947.patch
>
>
> 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)
Locked
