T
- the type of the descriptorpublic abstract class IgnorableDescriptor<T extends IgnorableDescriptor<T>> extends AbstractDescriptor<T>
Constructor and Description |
---|
IgnorableDescriptor() |
Modifier and Type | Method and Description |
---|---|
T |
ignored()
Marks the described item as being ignored.
|
boolean |
isIgnored()
Returns whether or not the item being described should be ignored and, therefore,
should not be included in the documentation.
|
attributes, description, getAttributes, getDescription
public final T ignored()
public final boolean isIgnored()
true
if the item should be ignored, otherwise false
.