[jira] [Commented] (OPENNLP-789) Extend JavaDoc for WSD component

["ASF GitHub Bot (Jira)" <ji...@apache.org>]

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

ASF GitHub Bot commented on OPENNLP-789:
----------------------------------------

mawiesne opened a new pull request, #200:
URL: https://github.com/apache/opennlp-sandbox/pull/200

   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:
   - [x] Is there a JIRA ticket associated with this PR? Is it referenced 
        in the commit message?
   
   - [x] 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.
   
   - [x] Has your PR been rebased against the latest commit within the target branch (typically main)?
   
   - [x] Is your initial contribution a single, squashed commit?
   
   ### For code changes:
   - [x] Have you ensured that the full suite of tests is executed via `mvn clean install` at the root opennlp-sandbox 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](https://www.apache.org/legal/resolved.html#category-a)? 
   - [ ] If applicable, have you updated the LICENSE file, including the main LICENSE file in opennlp-sandbox folder?
   - [ ] If applicable, have you updated the NOTICE file, including the main NOTICE file found in opennlp-sandbox 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 GitHub Actions for build issues and submit an update to your PR as soon as possible.
   




> Extend JavaDoc for WSD component
> --------------------------------
>
>                 Key: OPENNLP-789
>                 URL: https://issues.apache.org/jira/browse/OPENNLP-789
>             Project: OpenNLP
>          Issue Type: Improvement
>          Components: wsd
>            Reporter: Jörn Kottmann
>            Assignee: Martin Wiesner
>            Priority: Major
>              Labels: wsd
>             Fix For: 2.5.2
>
>
> The WSDisambiguator is the main interface for the wsd component. It should have much more javadocs explaining what it does and what wsd is.
> Additionally add at least short javadocs to each class and method in the disambiguator package. One sentence is the minimum here.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)