This parameter allows to hide completely from the generated documentation some intermediate classes of your internal implementation (that for some reasons need to be public), however, to preserve documenting of some fields and methods (defined within those classes), which are supposed to be part of an open API.
This may be particularly helpful when you will need next time to change your implementation while keeping intact what you have declared in your open API.
The annotation types specified in this parameter are treated as the following.
A class will be never mentioned in the documentation when at least one of the conditions is met:
The overall effect should be that the generated documentation will look as if the excluded classes themselves did never exist at all, however, everything else is in place and correct. (For that matter, see also the description of the "Filter Classes & Members" parameter group.)
Each annotation type must be specified with its fully qualified name (e.g. java.lang.Deprecated
).
Multiple annotation type names must be separated with new lines ('\n'), semicolons (';') or colons (':').
For example:
my.core.util.Internal my.project.api.Exclude