search

Azure / autorest-clientruntime-for-java

The runtime libraries for AutoRest generated Java clients.
MIT License
20 stars 58 forks source link

[v3] Reduce the number of classes listed in the JavaDoc to bare minimum #548

Open anuchandy opened 5 years ago

anuchandy commented 5 years ago

Move all eligible types to implementation package or make them package private.

[Details from @JonathanGiles]:

Because we are baselining on JDK 8 we unfortunately do not get the benefit of modules, however, it would be useful if an ‘implementation’ package could be introduced, with non-public API being moved into that package, or alternatively, non-public API being made package-protected so that it does not become part of the public API surface area. I would like to see as much moved under the implementation package or made package-protected as possible, because eventually we might baseline on JDK 9+, at which point we would not export these packages and we wouldn’t have a painful refactoring exercise to undertake. A few classes that jump out as potential candidates include (but this is not an exhaustive list) are below. Your mission should be to reduce the number of classes listed in the JavaDoc to the bare minimum Base64Url, UnixTime, ReactorNettyClient, ContentType, UrlBuilder, Slf4jLogger and SystemOutLogger, RequestIdPolicy

anuchandy commented 5 years ago

Related work item https://github.com/Azure/autorest-clientruntime-for-java/issues/469

anuchandy commented 5 years ago

Related work https://github.com/Azure/autorest-clientruntime-for-java/issues/585