Gathers information about the behavior a plugin adds at runtime.
| Type | Name and description |
|---|---|
java.lang.String |
artefactType |
java.lang.String |
currentDocumentation |
java.util.List<DocumentedMethod> |
methods |
java.util.List<DocumentedProperty> |
properties |
java.util.List<DocumentedMethod> |
staticMethods |
| Type Params | Return Type | Name and description |
|---|---|---|
|
DocumentationContext |
document(java.lang.String doc)Stores documentation for the next method or property to be added |
|
DocumentationContext |
documentMethod(java.lang.String artefact, java.lang.Class type, java.lang.String name, java.lang.Class<?>[] arguments)Documents an instance method |
|
DocumentationContext |
documentProperty(java.lang.String artefact, java.lang.Class type, java.lang.String name)Documents a property |
|
DocumentationContext |
documentStaticMethod(java.lang.String artefact, java.lang.Class type, java.lang.String name, java.lang.Class<?>[] arguments)Documents a static method |
|
static DocumentationContext |
getInstance() |
|
boolean |
hasMetadata() |
|
boolean |
isActive() |
|
void |
reset() |
|
void |
setActive(boolean b) |
| Methods inherited from class | Name |
|---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Stores documentation for the next method or property to be added
Documents an instance method
Documents a property
Documents a static method