TypeDoc
TypeScript
の型注釈とドキュメントの記述からHTML、Markdown、JSONなどによるドキュメンテーションを生成するツール。
公式サイト:
TypeDoc
TypeDocが出力するJSON
Development | TypeDoc
によれば、TypeDocはTypeScriptの構文木やドキュメントを、TypeDoc内部のモデルである
Reflection
に変換して、それをHTMLやJSONの出力に用いている。
一つのTypeScript Projectが一つの
ProjectReflection
に変換され、
ProjectReflection.children
の中にプロジェクト中の各シンボルに対応するReflectionが木構造になるように入る。