[jira] [Commented] (OPENNLP-1429) Add the Internal annotation to interfaces and classes documented accordingly

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

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

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

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

   Change
   -
   
   - adds `Internal` annotation to code which has existing hints/notes on internal use
   - improves some JavaDoc by linking to existing classes or interfaces
   - fixes inconsistent JavaDoc in `SentenceModelLoader`
   - adds 'final' modifier where useful and applicable
   - adds 'Override' annotation where useful and applicable
   - fixes some typos
   
   Tasks
   -
   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 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](http://www.apache.org/legal/resolved.html#category-a)? 
   - [ ] 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:
   - [x] 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.
   




> Add the Internal annotation to interfaces and classes documented accordingly
> ----------------------------------------------------------------------------
>
>                 Key: OPENNLP-1429
>                 URL: https://issues.apache.org/jira/browse/OPENNLP-1429
>             Project: OpenNLP
>          Issue Type: Improvement
>    Affects Versions: 2.1.0
>            Reporter: Martin Wiesner
>            Assignee: Martin Wiesner
>            Priority: Minor
>             Fix For: 2.1.1
>
>
> {{Recently the @Internal annotation was introduced. It can be used as a marker to signal that classes, interfaces or method signatures might change. It should be used throughout all classes that have JavaDoc related text comments.}}
> Aims:
>  * {{Introduce @Internal where appropriate}}
>  * Check / improve JavaDoc formatting or style.



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