Parses doc-comment tags from raw comment text.

Supported tags: @yields Marks function as yieldable (no arguments) @param [description] Parameter documentation (name must match a known param) @param -- [desc] Parameter with explicit type override @return [description] Return value documentation @return -- [description] Return with explicit type @error -- [description] Documents a possible error (type parsed if -- present) @unreleased Marks as unreleased @since Version when this was introduced @deprecated Marks as deprecated @deprecated [description] Deprecated with reason @deprecated -- [desc] Deprecated at version with reason @private Marks as private (excluded from public docs) @ignore Totally excluded from generated documentation @reexportonly Hide on source module; show when re-exported @tag Adds a custom tag

API Reference

Types

ParsedParam

type ParsedParam = { name: string, description: string, typeOverride: string? }

name: string

description: string

typeOverride: string?

ParsedReturn

type ParsedReturn = { description: string, type: string? }

description: string

type: string?

ParsedError

type ParsedError = { description: string, type: string? }

description: string

type: string?

DeprecatedInfo

type DeprecatedInfo = { version: string?, description: string? }

version: string?

description: string?

ParsedDoc

type ParsedDoc = { body: string, params: { ParsedParam }, returns: { ParsedReturn }, errors: { ParsedError }, yields: boolean, unreleased: boolean, since: string?, deprecated: DeprecatedInfo?, private: boolean, ignore: boolean, reexportOnly: boolean, tags: { string } }

body: string

params: { ParsedParam }

returns: { ParsedReturn }

errors: { ParsedError }

yields: boolean

unreleased: boolean

since: string?

deprecated: DeprecatedInfo?

private: boolean

ignore: boolean

reexportOnly: boolean

tags: { string }