[
https://issues.apache.org/jira/browse/JAMES-3633?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17399443#comment-17399443
]
Benoit Tellier edited comment on JAMES-3633 at 8/16/21, 2:09 AM:
-----------------------------------------------------------------
Hello [~CoolKangaroo2020],
> Would you like to add Javadoc for these API [...] ?
> If there is anything I can help with?
Contributions welcome indeed :-)
I think especially the mailet API can benefit from it.
To be fairly honnest the James devs now tend to strive for "Clean code"
guidelines, trying to write self speaking code, thus the amount of needed
JavaDoc decreases. Likely we could update the contributing guidelines.
Cheers,
Benoit
was (Author: btellier):
Hello [~CoolKangaroo2020],
> Would you like to add Javadoc for these API [...] ?
> If there is anything I can help with?
Contributions welcome indeed :-)
I think especially the mailet API can benefit from it.
To be fairly honnest the James devs now tend to strive for "Clean code"
guidelines, trying to write self speaking code, thus the amount of needed
JavaDoc decreases.
Cheers,
Benoit
> Missing Javadoc
> ---------------
>
> Key: JAMES-3633
> URL: https://issues.apache.org/jira/browse/JAMES-3633
> Project: James Server
> Issue Type: Wish
> Reporter: CoolGuy
> Priority: Minor
>
> Hello! I find in your [Contributing
> guidelines|https://james.apache.org/contribute.html that
> ??Javadoc MUST exist on all API methods.??
> However, I still witness some public methods without Javadocs, e.g., many
> Java files under the path
> ??apache_james-project/mdn/src/main/java/org/apache/james/mdn/?? are not
> accompanied with Javadoc.
> I also find missing javadoc in the following files:
> * mailet/api/src/main/java/org/apache/mailet/Serializer.java
> * mailet/api/src/main/java/org/apache/mailet/Attribute.java
> * mailet/api/src/main/java/org/apache/mailet/DsnParameters.java
> ......
> Would you like to add Javadoc for these API, or they are just not that
> important?
> If there is anything I can help with?
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
