docast-util-from-docs

docast utility that turns docblock comments into a syntax tree.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
• Syntax
• Syntax tree
• Types
• Contribute

What is this?

This package is a utility that takes source documents and files containing docblock comments and turns them into abstract syntax trees.

When should I use this?

TODO: when should i use this?

Install

This package is ESM only.

yarn add @flex-development/docast-util-from-docs @flex-development/docast @types/mdast @types/unist

From Git:

yarn add @flex-development/docast-util-from-docs@flex-development/docast-util-from-docs

See Git - Protocols | Yarn  for details on requesting a specific branch, commit, or tag.

Use

TODO: use

API

TODO: api

Syntax

TODO: syntax

Syntax tree

The syntax tree is docast.

Types

This package is fully typed with TypeScript.

Contribute

See CONTRIBUTING.md.