[jira] [Commented] (OFBIZ-9148) Check and enhance the Javadoc rules/documentation for the project

[Nicolas Malin (Jira)]

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

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

Quoting Taher's suggestion at https://issues.apache.org/jira/browse/OFBIZ-9144?focusedCommentId=15759223&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-15759223
bq. remove from build.gradle the "failOnError" flag so that if anyone submits invalid javadocs in the future the buildbot would fail.
If we do so, like we do CTR commits, we can close this issue; or at least have a peace of mind with Javadoc compliance where reviewing commits and let the hard work to BuilBot. Then of course we would fix issues with Javadoc compliance if it happens.

> Check and enhance the Javadoc rules/documentation for the project
> -----------------------------------------------------------------
>
>                 Key: OFBIZ-9148
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-9148
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: Confluence
>            Reporter: Michael Brohl
>            Assignee: Michael Brohl
>            Priority: Minor
>
> We are currently working on a huge amount of invalid Javadoc entries in our codebase. We'll have to check if we already have some documentation on how to writer proper Javadoc and how to avoid the biggest mistakes and maybe enhance it.
> We also have to check the Javadoc during review of contributions and should ask for creation or correction of proper Javadoc just like we do with code.

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