Document imported types

[Gozala]

Right now if I have code like this:

import {Maybe} from "maybe.ts"

export const toMaybe =
  <x, a>(result: Result<x, a>): Maybe<a> =>
    result.isOk ? result.value : null

export type Result<x, a> = ...

typedoc generates docs such that Maybe<a> is completely undocumented.

It would be great to have an option to either generate docs for imports as well or alternatively have a way to provide external links.

[vekexasia]

👍 for this

[Gerrit0]

In 0.20, TypeDoc will document whatever you export. Changing the code to:

import {Maybe} from "maybe.ts"

export * as MaybeTS from "maybe.ts"

export const toMaybe =
  <x, a>(result: Result<x, a>): Maybe<a> =>
    result.isOk ? result.value : null
export type Result<x, a> = { isOk: true, value: a } | { isOk: false, err: x }

Will result in documentation like this, with links going where you would expect: