Package com.linecorp.armeria.server.docs
@NonNullByDefault
package com.linecorp.armeria.server.docs
Documentation service.
-
ClassDescriptionDescription of a type, a field, a method or a parameter.Builds a new
DocService
.A filter which includes or excludes service methods when building aDocService
.Generates theServiceSpecification
s of the supportedService
s.A supporting base class for implementing the standard pattern of extracting docstrings from arbitrary files in a particular classpath location.Metadata about the endpoints exposed by aService
.Creates a newEndpointInfo
using the builder pattern.Metadata about an enum type.Metadata about an enum value.Metadata about an exception type.Metadata about a field of a struct or an exception.Creates a newFieldInfo
using the builder pattern.The location of a field.The requirement level of a field.Supported markup types inDescription
.Metadata about a function of aService
.Metadata about a named type.Creates a newNamedTypeInfo
loaded dynamically via Java SPI (Service Provider Interface).Metadata about aService
.Metadata about a struct type.Type signature of a method parameter, a method return value or a struct/exception field.