@eryx/eryxdoc/extract Module

JSON

Public API for extracting structured documentation from a Luau parse result.

Usage:

local extract = require("eryxdoc/extract")
local luau = require("@eryx/luau")

local source = fs.openSync("mymodule.luau"):readSync()
local result = luau.parse(source, { captureComments = true })
local docs = extract.extract(result, string.split(source, "\n"))
-- docs.functions, docs.types, docs.constants, docs.moduleDescription

Summary

Functions

extract.extract(result: luau.ParseResult, sourceLines: { string })ExtractedDocs

API Reference

Functions

extract.extract

extract.extract(result: luau.ParseResult, sourceLines: { string })ExtractedDocs

Types

SignaturePart

ParamMeta

type ParamMeta = types.ParamMeta

ReturnMeta

type ReturnMeta = types.ReturnMeta

SignatureMeta

FuncDoc

type FuncDoc = types.FuncDoc

TypeDoc

type TypeDoc = types.TypeDoc

ConstDoc

type ConstDoc = types.ConstDoc

ExtractedDocs