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

["Taher Alkhateeb (JIRA)" <ji...@apache.org>]

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

Taher Alkhateeb commented on OFBIZ-9144:
----------------------------------------

This is a little bash code snippet that I use to quickly review the errors and fix them
{code}
./gradlew javadoc 2> javadoc.log
grep error javadoc.log > javadoc_errors.log
rm javadoc.log
{code}

Then I view the javadoc_errors.log and fix it line by line

> 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
>            Assignee: Taher Alkhateeb
>            Priority: Minor
>
> The OFBiz javadocs are not standard compliant and not legally correct which we 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)