[
https://issues.apache.org/jira/browse/OPENNLP-1302?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17080442#comment-17080442
]
ASF GitHub Bot commented on OPENNLP-1302:
-----------------------------------------
jzonthemtn commented on issue #374: OPENNLP-1302 add missing param tags
URL: https://github.com/apache/opennlp/pull/374#issuecomment-611998517
@jongwoojeff Thanks for the contribution! You're doing great!
For the `get` and `put` functions, could you add a line above the `param`
that describes what the function does?
We also try to add the JIRA ticket number to the git commit message, like
"OPENNLP-1302: add missing param tags". This just allows traceability between
the ticket and the code change.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> Javadoc
> -------
>
> Key: OPENNLP-1302
> URL: https://issues.apache.org/jira/browse/OPENNLP-1302
> Project: OpenNLP
> Issue Type: Documentation
> Components: Documentation
> Affects Versions: 1.9.2
> Reporter: Jongwoo Jeon
> Priority: Trivial
> Labels: documentation
> Fix For: 1.9.2
>
>
> Hi, I've noticed that in [opennlp
> github|[https://github.com/apache/opennlp/tree/master/opennlp-uima/src/main/java/opennlp/uima/normalizer]],
> Normalizer.java and StringDictionary.java seem to miss @param and @return
> tags for documentation. The other file, NumberUtil.java, seems to have these
> tags. Just wondering if these tags were omitted on purpose.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
