Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/update/add Javadoc documentation #75

Merged
merged 1 commit into from
Oct 16, 2022
Merged

Fix/update/add Javadoc documentation #75

merged 1 commit into from
Oct 16, 2022

Conversation

spannm
Copy link
Contributor

@spannm spannm commented Aug 31, 2022

This PR improves the project's Javadoc in several ways:

  • Remove obsolete Subversion wildcards (e.g. $Id$)
  • Correct typos and bogus docs (e.g. '@return String', 'Description of the Method')
  • No Javadoc errors left in the project
  • Few Javadoc warnings remain but only of type 'no comment'

Following this checklist to help us incorporate your contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [JXR-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace JXR-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its clean verify).

If your pull request is about ~20 lines of code you don't need to sign an Individual Contributor License Agreement if you are unsure please ask on the developers list.

To make clear that you license your contribution under the Apache License Version 2.0, January 2004 you have to acknowledge this by using the following check-box.

Remove obsolete Subversion wildcards (e.g. $Id$)
Correct typos and bogus docs (e.g. '@return String', 'Description of the Method')
No Javadoc errors left in the project
Few Javadoc Warnings remain but only of type 'no comment'
@spannm
Copy link
Contributor Author

spannm commented Oct 14, 2022

Hi @slawekjaranowski hope you are doing great. Could you look at my PR and hopefully merge?

@slawekjaranowski slawekjaranowski merged commit 05e25ef into apache:master Oct 16, 2022
@slawekjaranowski
Copy link
Member

@sman-81 thanks

@spannm spannm deleted the sman-81-jxr-javadoc branch October 16, 2022 09:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants