export declare const Class: (
  documentable: Documentable,
  signature: string,
  methods: ReadonlyArray<Method>,
  staticMethods: ReadonlyArray<Method>,
  properties: ReadonlyArray<Property>
) => Class

export declare const Constant: (documentable: Documentable, signature: string) => Constant

export declare const Documentable: (
  name: string,
  description: O.Option<string>,
  since: O.Option<string>,
  deprecated: boolean,
  examples: ReadonlyArray<Example>,
  category: O.Option<string>
) => Documentable

export declare const Export: (documentable: Documentable, signature: string) => Export

export declare const Function: (documentable: Documentable, signatures: ReadonlyArray<string>) => Function

export declare const Interface: (documentable: Documentable, signature: string) => Interface

export declare const Method: (documentable: Documentable, signatures: ReadonlyArray<string>) => Method

export declare const Module: (
  documentable: Documentable,
  path: ReadonlyArray<string>,
  classes: ReadonlyArray<Class>,
  interfaces: ReadonlyArray<Interface>,
  functions: ReadonlyArray<Function>,
  typeAliases: ReadonlyArray<TypeAlias>,
  constants: ReadonlyArray<Constant>,
  exports: ReadonlyArray<Export>
) => Module

export declare const Property: (documentable: Documentable, signature: string) => Property

export declare const TypeAlias: (documentable: Documentable, signature: string) => TypeAlias

export declare const ordModule: Ord.Ord<Module>

export interface Class extends Documentable {
  readonly _tag: 'Class'
  readonly signature: string
  readonly methods: ReadonlyArray<Method>
  readonly staticMethods: ReadonlyArray<Method>
  readonly properties: ReadonlyArray<Property>
}

export interface Constant extends Documentable {
  readonly _tag: 'Constant'
  readonly signature: string
}

export interface Documentable {
  readonly name: string
  readonly description: O.Option<string>
  readonly since: O.Option<string>
  readonly deprecated: boolean
  readonly examples: ReadonlyArray<Example>
  readonly category: O.Option<string>
}

export type Example = string

export interface Export extends Documentable {
  readonly _tag: 'Export'
  readonly signature: string
}

export interface Function extends Documentable {
  readonly _tag: 'Function'
  readonly signatures: ReadonlyArray<string>
}

export interface Interface extends Documentable {
  readonly _tag: 'Interface'
  readonly signature: string
}

export interface Method extends Documentable {
  readonly signatures: ReadonlyArray<string>
}

export interface Module extends Documentable {
  readonly path: ReadonlyArray<string>
  readonly classes: ReadonlyArray<Class>
  readonly interfaces: ReadonlyArray<Interface>
  readonly functions: ReadonlyArray<Function>
  readonly typeAliases: ReadonlyArray<TypeAlias>
  readonly constants: ReadonlyArray<Constant>
  readonly exports: ReadonlyArray<Export>
}

export interface Property extends Documentable {
  readonly signature: string
}

export interface TypeAlias extends Documentable {
  readonly _tag: 'TypeAlias'
  readonly signature: string
}