OPENNLP-1302: add missing param tags

[jongwoojeff]

Thank you for contributing to Apache OpenNLP.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:
[* ] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?

[*] Does your PR title start with OPENNLP-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

[*] Has your PR been rebased against the latest commit within the target branch (typically master)?

[*] Is your initial contribution a single, squashed commit?

For code changes:
[ ] Have you ensured that the full suite of tests is executed via mvn clean install at the root opennlp folder?
[ ] Have you written or updated unit tests to verify your changes?
[ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
[ ] If applicable, have you updated the LICENSE file, including the main LICENSE file in opennlp folder?
[ ] If applicable, have you updated the NOTICE file, including the main NOTICE file found in opennlp folder?
For documentation related changes:
[* ] Have you ensured that format looks appropriate for the output in which it is rendered?
Note:
Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.

[jongwoojeff]

Hi, this is my first time contributing to an open source project. Currently taking baby steps to see how things work. I just added missing tags for documentation. Any feedback will be much appreciated.

[jzonthemtn]

@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.

[jongwoojeff]

@jzonthemtn Thank you so much for replying! I've made the changes you suggested. Let me know if you have more feedback. Feel free to suggest a task that seems suitable for a newbie.

[jongwoojeff]

Hey everyone, I noticed that 2 people have approved my changes but it didn't get merged to the master branch. I was wondering if there are further changes or steps required for my changes to get merged. Thank you for the support!

[jongwoojeff]

Thank you @jzonthemtn for merging! I would love to dive deeper in this project. Does anyone recommend any tasks that are doable for a newbie or should I try solving trivial issues posted on Apache OpenNLP JIRA? Thanks for the support!

[jzonthemtn]

@jongwoojeff I know documentation work is not fun at all but it is a good way to learn more about a project like OpenNLP. I know we are missing a lot of Javadocs in places. There are probably places to improve the manual, too.

There are a few tasks listed for wanting contributions at https://opennlp.apache.org/get-involved.html.

And if you haven't already, be sure to join the user and dev mailing lists at https://opennlp.apache.org/mailing-lists.html. When we do a new release it would be helpful if you could help us test it and vote for the release.

Thanks again for your contribution!

[jongwoojeff]

@jzonthemtn Thanks for the advice! I'll continue working on documentation for now (can't disagree that it is a great way to learn) and join the user and dev mailing lists. Thanks for the support!