How to Ignore API

Use the ignore rule to exclude specific classes or methods from API documentation.

By Annotation

ignore=groovy:it.hasAnn("java.lang.Deprecated")

By Name Pattern

ignore=#regex:^internal.*

By Custom Logic

# Ignore methods that are not public
ignore=groovy:!it.hasModifier("public")

# Ignore specific gRPC methods
ignore=groovy:it.name() == "getServiceDescriptor" || it.name() == "bindService"

See ignore for more details.