doc

Documentation

Overview

Package doc builds web friendly documentation of the idl.

Index

• Constants
• func Build(outDir string, idl []typeinfo.TypeSet) (err error)
• func BuildIdl(outDir string, tem *template.Template, g GlobalData) (err error)
• func BuildSlots(outDir string, tem *template.Template, g GlobalData) (err error)
• func BuildSpec(t *typeinfo.Flow) (ret string)
• func WriteDocFile(outPath string, tem *template.Template, name string, data any) (err error)
• type FlowInfo
  • func (c FlowInfo) SourceLink() string
  • func (c FlowInfo) Terms() (ret []typeinfo.Term)
• type GlobalData
• type PrimInfo
• type SlotInfo

Constants

const SourceUrl = "https://pkg.go.dev/git.sr.ht/~ionous/tapestry"

Functions

func Build

func Build(outDir string, idl []typeinfo.TypeSet) (err error)

outDir can point to a temp directory if need be

func BuildIdl

func BuildIdl(outDir string, tem *template.Template, g GlobalData) (err error)

func BuildSlots

func BuildSlots(outDir string, tem *template.Template, g GlobalData) (err error)

func BuildSpec

func BuildSpec(t *typeinfo.Flow) (ret string)

Build the document style signature for this flow it's different than the actual signature because, among other things, it includes markers for optional elements.

func WriteDocFile

func WriteDocFile(outPath string, tem *template.Template, name string, data any) (err error)

Types

type FlowInfo

type FlowInfo struct {
	Idl string // ex. "story"
	*typeinfo.Flow
	Spec string // Define something:
}

func (FlowInfo) SourceLink

func (c FlowInfo) SourceLink() string

link to go package documentation

func (FlowInfo) Terms

func (c FlowInfo) Terms() (ret []typeinfo.Term)

type GlobalData

type GlobalData struct {
	// contains filtered or unexported fields
}

type PrimInfo

type PrimInfo struct {
	Idl string
	typeinfo.T
}

type SlotInfo

type SlotInfo struct {
	Idl string
	*typeinfo.Slot
}