Skip to content

OPENNLP-1422 Enhance JavaDoc in opennlp.tools.formats sub-packages#468

Merged
mawiesne merged 1 commit intoapache:mainfrom
mawiesne:OPENNLP-1422_Enhance_JavaDoc_in_opennlp.tools.formats_sub-packages
Dec 26, 2022
Merged

OPENNLP-1422 Enhance JavaDoc in opennlp.tools.formats sub-packages#468
mawiesne merged 1 commit intoapache:mainfrom
mawiesne:OPENNLP-1422_Enhance_JavaDoc_in_opennlp.tools.formats_sub-packages

Conversation

@mawiesne
Copy link
Copy Markdown
Contributor

@mawiesne mawiesne commented Dec 22, 2022

Change

  • 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
  • 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

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:

  • 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:

  • 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 GitHub Actions for build issues and submit an update to your PR as soon as possible.

Copy link
Copy Markdown
Contributor

@rzo1 rzo1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should add something similar for @ThreadSafe. Might be a good thing for doc generation in the future.

@mawiesne
Copy link
Copy Markdown
Contributor Author

Maybe we should add something similar for @ThreadSafe. Might be a good thing for doc generation in the future.

@rzo1 If you'd open a Jira issue for your idea, I can contribute sth for that.

@rzo1
Copy link
Copy Markdown
Contributor

rzo1 commented Dec 23, 2022

Maybe we should add something similar for @ThreadSafe. Might be a good thing for doc generation in the future.

@rzo1 If you'd open a Jira issue for your idea, I can contribute sth for that.

OPENNLP-1424

- 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
@mawiesne mawiesne merged commit 82ed136 into apache:main Dec 26, 2022
@mawiesne mawiesne deleted the OPENNLP-1422_Enhance_JavaDoc_in_opennlp.tools.formats_sub-packages branch December 26, 2022 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants