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

Hide impl package from javadoc (and module declaration) #487

Closed
Marcono1234 opened this issue Mar 30, 2021 · 4 comments
Closed

Hide impl package from javadoc (and module declaration) #487

Marcono1234 opened this issue Mar 30, 2021 · 4 comments
Labels
feature request A feature has been asked for or suggested by the community

Comments

@Marcono1234
Copy link
Contributor

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

  • Hide the package from javadoc
  • Add a package-info.java file documenting that the package is part of the internal implementation and classes inside of it should not be used.
  • Don't export the package from the module declaration, see also Add module system support #483. (Ideally in the next major version since it is a breaking change)
  • Remove mentions of impl classes from API documentation:
    • NullClaim: Mentioned from
      • Header.getHeaderClaim
      • Payload.getClaim
@Marcono1234 Marcono1234 added the feature request A feature has been asked for or suggested by the community label Mar 30, 2021
This was referenced Mar 31, 2021
@lbalmaceda
Copy link
Contributor

Hide the package from javadoc

This would be solved with the changes you proposed for #489.

Add a package-info.java file documenting that the package is part of the internal implementation and classes inside of it should not be used.

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 impl package.

Remove mentions of impl classes from API documentation:

Good catch! These should also be removed. If you want to take them as well with the same PR that's OK to us.

@Marcono1234
Copy link
Contributor Author

Add a package-info.java file documenting that the package is part of the internal implementation and classes inside of it should not be used.

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 impl package.

Maybe it would be useful nonetheless so it is obvious to users browsing the code that the package contains internal implementation details.

@jimmyjames
Copy link
Contributor

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.

@jimmyjames
Copy link
Contributor

Fixed with #496, shipped in 3.16.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request A feature has been asked for or suggested by the community
Projects
None yet
Development

No branches or pull requests

3 participants