@Documented @Target(value=METHOD) @Retention(value=SOURCE) public @interface Endpoint
Modifier and Type | Optional Element and Description |
---|---|
boolean |
describeByClass
Indicates that the class description should be copied in the documentation of this endpoint,
instead of the description of the annotated method.
|
String |
group
Specify an optional group within the
Ops class. |
String |
name
Name for the wrapper method used in the
Ops class. |
public abstract String group
Ops
class.
This value overrides the group selected at class level with the @Operator
annotation for this specific endpoint.
Operator.group()
public abstract String name
Ops
class.
This value overrides the name selected at class level with the @Operator
annotation for this specific endpoint.
Operator.name()
public abstract boolean describeByClass
Tags of the annotated method, like @param
and @return
, are copied to
the endpoint documentation independently from this value.
Copyright © 2015–2022. All rights reserved.