[jira] [Commented] (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] [Commented] (OFBIZ-11947) Checkstyle: Add Javadoc for classes designed for extension

Nicolas Malin (Jira)

    [ https://issues.apache.org/jira/browse/OFBIZ-11947?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17178308#comment-17178308 ]

Jacques Le Roux commented on OFBIZ-11947:
-----------------------------------------

Hi Suraj,

I of course, did not review both patches in detail. I reviewed half of them both, they seem good to me. The check and javaDoc tasks are OK as is launching OFBIz bak and front ends. Kudos for, I guess, this hard hand work and the resulting 1362 less errors!

+1 for commit.

> 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)