[
https://issues.apache.org/jira/browse/OFBIZ-9144?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Taher Alkhateeb updated OFBIZ-9144:
-----------------------------------
Description:
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!
was:
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!
> 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
>
> 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)
