[
https://issues.apache.org/jira/browse/OFBIZ-9148?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17935435#comment-17935435
]
Jacques Le Roux edited comment on OFBIZ-9148 at 3/14/25 8:15 AM:
-----------------------------------------------------------------
It's because of your comment above.
bq. 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.
BTW OFBIZ-12742 is not a duplicate., it's only about fixing Javadoc warnings.
I found it later yesterday after having committed but not pushed a few changes.
I agree I should not have closed, reopening for those interested.
was (Author: jacques.le.roux):
It's because of your comment above.
bq. 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.
OFBIZ-12742 is only about fixing Javadoc warnings. I agree I should not have
close, reopening for those interested
> 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: Jacques Le Roux
> Priority: Minor
> Fix For: Upcoming Branch
>
>
> 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
(v8.20.10#820010)
