ofbiz-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Brohl (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (OFBIZ-9144) refactor javadocs in OFBiz to be standards compliant
Date Sat, 17 Dec 2016 23:39:58 GMT

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

Michael Brohl commented on OFBIZ-9144:
--------------------------------------

Committed a bunch of corrections in r1774815.

I've attached a patch which deactivates the strict checks, see http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html.

Maybe we should put this in to be able to generate the javadocs without errors and work on
to clean them up in parallel?

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

Mime
View raw message