ofbiz-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sharan Foga (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (OFBIZ-9148) Check and enhance the Javadoc rules/documentation for the project
Date Fri, 16 Mar 2018 09:10:00 GMT

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

Sharan Foga commented on OFBIZ-9148:
------------------------------------

Link to Global Documentation task

> 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
(v7.6.3#76005)

Mime
View raw message