-
Notifications
You must be signed in to change notification settings - Fork 925
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
Hide impl
package from javadoc (and module declaration)
#487
Comments
This would be solved with the changes you proposed for #489.
If the package is no longer going to be included in the javadocs, we can probably skip this change if the intent is just to hide the
Good catch! These should also be removed. If you want to take them as well with the same PR that's OK to us. |
Maybe it would be useful nonetheless so it is obvious to users browsing the code that the package contains internal implementation details. |
I agree; it's worth adding. |
Fixed with #496, shipped in 3.16.0 |
Describe the problem you'd like to have solved
It appears the
impl
package contains part of the internal implementation and should not be used by the user.However, some of its classes are public and there is no indication to the user that they should not be used.
Describe the ideal solution
package-info.java
file documenting that the package is part of the internal implementation and classes inside of it should not be used.impl
classes from API documentation:NullClaim
: Mentioned fromHeader.getHeaderClaim
Payload.getClaim
The text was updated successfully, but these errors were encountered: