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

DATAJPA-1192 - Some JavaDocs and package-infos are not up-to-date #224

Closed

Conversation

Projects
None yet
3 participants
@kevin-peters
Copy link
Contributor

commented Oct 1, 2017

This PR corrects some JavaDocs which point to variables not existing (anymore) and other way around. It also fixes some broken @link references in the JavaDocs. At least it removes one a @NonNullApi annotation from package-info file where affected class methods may return null.

kevin-peters added some commits Oct 1, 2017

DATAJPA-1192 - Remove misleading annotation
Since (at least one) method(s) within this package may return null this @NonNullApi is misleading at this point and is removed
DATAJPA-1192 - Remove import / use qualifier instead
Since all other package-info files use full qualifier to identify annotations this should also be done here
DATAJPA-1192 - Fix JavaDocs
Correct @param variable declarations and @link references

@kevin-peters kevin-peters changed the title Issue/datajpa 1192 DATAJPA-1192 - Some JavaDocs (@params) and package-infos are not up-to-date Oct 1, 2017

@kevin-peters kevin-peters changed the title DATAJPA-1192 - Some JavaDocs (@params) and package-infos are not up-to-date DATAJPA-1192 - Some JavaDocs and package-infos are not up-to-date Oct 1, 2017

@odrotbohm

This comment has been minimized.

Copy link
Member

commented Oct 1, 2017

Let's open a separate ticket for the commit regarding the nullable API. The justification for the commit is misleading as it's basically not an argument: we declare API non-nullable and then add @Nullable annotations to the methods that are an exception to that. Generally disabling that is not really an option. I'll go ahead and merge the other two commits.

@odrotbohm odrotbohm self-assigned this Oct 1, 2017

odrotbohm added a commit that referenced this pull request Oct 1, 2017

DATAJPA-1192 - Polish JavaDoc.
Correct @param variable declarations and @link references.

Original pull request: #224.

odrotbohm added a commit that referenced this pull request Oct 1, 2017

DATAJPA-1192 - Use qualified import for @NonNullApi.
Switched to fully-qualified imports of Spring's @NonNullApi in package-info.java files that used explicit imports before.

Original pull request: #224.

odrotbohm added a commit that referenced this pull request Oct 1, 2017

DATAJPA-1192 - Polish JavaDoc.
Correct @param variable declarations and @link references.

Original pull request: #224.

odrotbohm added a commit that referenced this pull request Oct 1, 2017

DATAJPA-1192 - Polish JavaDoc.
Correct @param variable declarations and @link references.

Original pull request: #224.

odrotbohm added a commit that referenced this pull request Oct 1, 2017

DATAJPA-1192 - Polish JavaDoc.
Correct @param variable declarations and @link references.

Original pull request: #224.
@kevin-peters

This comment has been minimized.

Copy link
Contributor Author

commented Oct 2, 2017

Did create another ticket plus PR: Add nullable (and override). Sorry, did not know that the @nonnullapi is mandatory even if all affected methods in (sub-)packages may return null. Will keep that in mind. ;)

@schauder schauder force-pushed the spring-projects:master branch from e164784 to 01e36db Nov 1, 2018

@schauder

This comment has been minimized.

Copy link
Contributor

commented Jul 2, 2019

Seems this was already merged and just never got closed.

@schauder schauder closed this Jul 2, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.