Summary
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD] )
Provides a concise summary for annotated elements.
This annotation offers brief descriptions that are suitable for:
API documentation summaries
UI tooltips and help text
Logging and monitoring labels
Code generation metadata
Administrative interfaces
The summary should be brief (1-2 sentences) and focus on the most important aspect of the annotated element. For more detailed descriptions, use @Description.
Example usage:
@Summary("Manages customer orders and fulfillment")
class OrderService {
@Summary("Creates a new order for a customer")
fun createOrder(request: CreateOrderRequest): OrderId {
// Implementation
}
@Summary("Current status of the order")
val status: OrderStatus
}Content copied to clipboard
Parameters
value
The summary text. Should be concise and descriptive.
See also
for longer, more detailed descriptions