[jira] [Comment Edited] (OFBIZ-9144) refactor javadocs in OFBiz to be standards compliant

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

[jira] [Comment Edited] (OFBIZ-9144) refactor javadocs in OFBiz to be standards compliant

Nicolas Malin (Jira)

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

Michael Brohl edited comment on OFBIZ-9144 at 12/18/16 9:41 AM:
----------------------------------------------------------------

Yes, the flags does not show any errors in the log. I have tested this and it works.

If we want this to be in the codebase I will commit it during the day and write a short comment how to disable.


was (Author: mbrohl):
Yes, the flags does not show any errors in the log. I have tested this and it works.

If we want this to be in the codebase I will commit it during the day adn write a short comment how to disable.

> refactor javadocs in OFBiz to be standards compliant
> ----------------------------------------------------
>
>                 Key: OFBIZ-9144
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-9144
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: ALL COMPONENTS
>    Affects Versions: Upcoming Release
>            Reporter: Taher Alkhateeb
>            Priority: Minor
>         Attachments: OFBIZ-9144_xdoclint_off.patch
>
>
> The OFBiz javadocs are not standard compliant and not legally correct which means that generating javadocs would fail. As a temporary workaround we added to the gradle build script:
> {code} javadoc.failOnError = false{code}
> However, the root solution would be to fix all the errors in javadocs and eventually remove the above code snippet from gradle. For more about compliance with javadocs you can read [javadoc style document|http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html]
> The best way to fix this issue is by:
> # running "./gradlew javadoc"
> # fixing the javadoc errors
> # running "./gradlew javadoc" again and ensuring the errors are gone
> This is a large task (might need to be broken down to many sub-tasks). Any help is greatly appreciated!



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)