Skip to content

Interface: OxContentExtractionOptions

Controls which declarations and metadata ox-content extracts from entry points.

Signature

ts
export interface OxContentExtractionOptions

Properties

NameTypeDescription
externalDocs (optional)booleanPreserve external documentation links and metadata from source declarations. Default: false
externalPackageSources (optional)ExternalPackageSourceInput[]External packages used to resolve cross-package references in generated docs. Default: undefined
internal (optional)booleanInclude declarations marked as internal. Default: false
private (optional)booleanInclude declarations marked as private. Default: false
typeParameters (optional)booleanInclude generic type parameter declarations and descriptions in generated docs. Default: false