OPENNLP-1422 Enhance JavaDoc in opennlp.tools.formats sub-packages#468
Merged
mawiesne merged 1 commit intoapache:mainfrom Dec 26, 2022
mawiesne:OPENNLP-1422_Enhance_JavaDoc_in_opennlp.tools.formats_sub-packages
Merged
OPENNLP-1422 Enhance JavaDoc in opennlp.tools.formats sub-packages#468mawiesne merged 1 commit intoapache:mainfrom mawiesne:OPENNLP-1422_Enhance_JavaDoc_in_opennlp.tools.formats_sub-packages
mawiesne merged 1 commit intoapache:mainfrom
mawiesne:OPENNLP-1422_Enhance_JavaDoc_in_opennlp.tools.formats_sub-packages
Conversation
kinow
approved these changes
Dec 22, 2022
rzo1
reviewed
Dec 23, 2022
Contributor
rzo1
left a comment
There was a problem hiding this comment.
Maybe we should add something similar for @ThreadSafe. Might be a good thing for doc generation in the future.
rzo1
approved these changes
Dec 23, 2022
opennlp-tools/src/main/java/opennlp/tools/formats/BioNLP2004NameSampleStream.java
Outdated
Show resolved
Hide resolved
...p-tools/src/main/java/opennlp/tools/formats/irishsentencebank/IrishSentenceBankDocument.java
Outdated
Show resolved
Hide resolved
Contributor
Author
@rzo1 If you'd open a Jira issue for your idea, I can contribute sth for that. |
Contributor
|
- introduces `opennlp.tools.commons.Internal` annotation to transparently mark classes as 'internal use only' in JavaDoc - adds missing JavaDoc - improves existing documentation for clarity - addresses outdated/lost URLs that were gone with a 404 with appropriate alternatives, thanks rzo1 - removes superfluous text - adds 'final' modifier where useful and applicable - adds 'Override' annotation where useful and applicable - adds `package-info.java` files for several sub-packages - simplifies several constructors, removing duplicate code - fixes some typos
rzo1
approved these changes
Dec 26, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Change
opennlp.tools.commons.Internalannotation to transparently mark classes as 'internal use only' in JavaDocpackage-info.javafiles for several sub-packagesTasks
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 main)?
Is your initial contribution a single, squashed commit?
For code changes:
For documentation related changes:
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.