apiguardian
apiguardian copied to clipboard
@API Guardian
## Overview For Frameworks and libraries it is quite common to provide interfaces and classes. But not all interfaces are intended to be implemented by clients, or classes may not...
Some fluent APIs use multiple intermediate types to restrict the available methods depending on what methods were called earlier in the call chain. As an illustration, imagine a fictitious library...
`API.consumers` allows according to the documentation the usage of wildcards: > The supplied packages can be fully qualified package names or patterns containing asterisks that will be used as wildcards....
The current set of `Status` values looks consistent for most of projects. However, in a framework or library — which are intended to be used as building blocks — there...
## Ideas - Extract all public APIs and generate a report - Compare two versions of an artifact for release notes - Check correct usage of APIs (internally and externally)...
I'm missing API status that would mean "this is completely new feature and it will almost definitely change - expect SOME solution to problem solved by this, but don't get...
Status quo is that the statuses (huh, accidental wordplay, nice) are only described with javadocs. Missing part is some formal definition of state graph. This API is only documentational unless...
Please clearly indicate the names of the authors and the copyright date. One of the nice things about Maven's `pom.xml` file is that it defines a machine-readable format for listing...
### Add copyright information to Jar. For a customer project an OpenSource report has to be generated. Therefore a scanner was created to extract the copyright and licence information from...
Resolves #24.