[
https://issues.apache.org/jira/browse/OFBIZ-9148?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15759328#comment-15759328
]
Michael Brohl commented on OFBIZ-9148:
--------------------------------------
No, we can't close this issue.
It's about checking and enhancing the documentation and guidelines for
Javadocs. It's not only about errors.
You can have technically valid Javadocs which are bad, I've seen a lot of them
during the work on OFBIZ-9144.
> 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)
