You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by "CoolGuy (Jira)" <se...@james.apache.org> on 2021/08/15 09:31:00 UTC
[jira] [Updated] (JAMES-3633) Missing Javadoc
[ https://issues.apache.org/jira/browse/JAMES-3633?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
CoolGuy updated JAMES-3633:
---------------------------
Description:
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?
was:
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 commented code 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?
> 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: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org