doc

Documentation

Index

• func ConvertSwampMarkdown(markdownString string) (string, error)
• func ModuleToHtml(writer io.Writer, module *decorated.Module) error
• func PackagesToHtmlPage(writer io.Writer, packages []*loader.Package) error
• type ConvertState
• type DocPackage
• type DocRoot
  • func FilterOutDocRoot(packages []*loader.Package) *DocRoot
• type HtmlColorer
  • func (c *HtmlColorer) AliasName(t *dectype.Alias)
  • func (c *HtmlColorer) AliasNameSymbol(t token.TypeSymbolToken)
  • func (c *HtmlColorer) BooleanLiteral(t token.BooleanToken)
  • func (c *HtmlColorer) CustomType(t *dectype.CustomTypeAtom)
  • func (c *HtmlColorer) CustomTypeName(t *dectype.CustomTypeReference)
  • func (c *HtmlColorer) CustomTypeVariant(t *dectype.CustomTypeVariantAtom)
  • func (c *HtmlColorer) Definition(t token.VariableSymbolToken)
  • func (c *HtmlColorer) InvokerType(t *dectype.InvokerType)
  • func (c *HtmlColorer) KeywordString(t string)
  • func (c *HtmlColorer) LeftPipe()
  • func (c *HtmlColorer) LocalType(t token.VariableSymbolToken)
  • func (c *HtmlColorer) LocalTypeName(s *dectype.LocalType)
  • func (c *HtmlColorer) ModuleReference(t token.TypeSymbolToken)
  • func (c *HtmlColorer) NewLine(indentation int)
  • func (c *HtmlColorer) NumberLiteral(t token.NumberToken)
  • func (c *HtmlColorer) OneSpace()
  • func (c *HtmlColorer) Operator(t token.OperatorToken)
  • func (c *HtmlColorer) OperatorString(t string)
  • func (c *HtmlColorer) Parameter(t token.VariableSymbolToken)
  • func (c *HtmlColorer) PrimitiveType(t token.TypeSymbolToken)
  • func (c *HtmlColorer) PrimitiveTypeName(t *ast.TypeIdentifier)
  • func (c *HtmlColorer) RecordField(t token.VariableSymbolToken)
  • func (c *HtmlColorer) RecordTypeField(t *dectype.RecordField)
  • func (c *HtmlColorer) RightArrow()
  • func (c *HtmlColorer) RightPipe()
  • func (c *HtmlColorer) String() string
  • func (c *HtmlColorer) StringLiteral(s token.StringToken)
  • func (c *HtmlColorer) TypeGeneratorName(t token.TypeSymbolToken)
  • func (c *HtmlColorer) TypeSymbol(t token.TypeSymbolToken)
  • func (c *HtmlColorer) UnmanagedName(t *ast.UnmanagedType)
  • func (c *HtmlColorer) UserInstruction(t string)
  • func (c *HtmlColorer) VariableSymbol(t token.VariableSymbolToken)

Functions

func ConvertSwampMarkdown

func ConvertSwampMarkdown(markdownString string) (string, error)

func ModuleToHtml

func ModuleToHtml(writer io.Writer, module *decorated.Module) error

func PackagesToHtmlPage

func PackagesToHtmlPage(writer io.Writer, packages []*loader.Package) error

Types

type ConvertState

type ConvertState = uint8

const (
	Normal ConvertState = iota
	InAdmonition
	InCodeExample
)

type DocPackage

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

type DocRoot

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

func FilterOutDocRoot

func FilterOutDocRoot(packages []*loader.Package) *DocRoot

type HtmlColorer

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

func (*HtmlColorer) AliasName

func (c *HtmlColorer) AliasName(t *dectype.Alias)

func (*HtmlColorer) AliasNameSymbol

func (c *HtmlColorer) AliasNameSymbol(t token.TypeSymbolToken)

func (*HtmlColorer) BooleanLiteral

func (c *HtmlColorer) BooleanLiteral(t token.BooleanToken)

func (*HtmlColorer) CustomType

func (c *HtmlColorer) CustomType(t *dectype.CustomTypeAtom)

func (*HtmlColorer) CustomTypeName

func (c *HtmlColorer) CustomTypeName(t *dectype.CustomTypeReference)

func (*HtmlColorer) CustomTypeVariant

func (c *HtmlColorer) CustomTypeVariant(t *dectype.CustomTypeVariantAtom)

func (*HtmlColorer) Definition

func (c *HtmlColorer) Definition(t token.VariableSymbolToken)

func (*HtmlColorer) InvokerType

func (c *HtmlColorer) InvokerType(t *dectype.InvokerType)

func (*HtmlColorer) KeywordString

func (c *HtmlColorer) KeywordString(t string)

func (*HtmlColorer) LeftPipe

func (c *HtmlColorer) LeftPipe()

func (*HtmlColorer) LocalType

func (c *HtmlColorer) LocalType(t token.VariableSymbolToken)

func (*HtmlColorer) LocalTypeName

func (c *HtmlColorer) LocalTypeName(s *dectype.LocalType)

func (*HtmlColorer) ModuleReference

func (c *HtmlColorer) ModuleReference(t token.TypeSymbolToken)

func (*HtmlColorer) NewLine

func (c *HtmlColorer) NewLine(indentation int)

func (*HtmlColorer) NumberLiteral

func (c *HtmlColorer) NumberLiteral(t token.NumberToken)

func (*HtmlColorer) OneSpace

func (c *HtmlColorer) OneSpace()

func (*HtmlColorer) Operator

func (c *HtmlColorer) Operator(t token.OperatorToken)

func (*HtmlColorer) OperatorString

func (c *HtmlColorer) OperatorString(t string)

func (*HtmlColorer) Parameter

func (c *HtmlColorer) Parameter(t token.VariableSymbolToken)

func (*HtmlColorer) PrimitiveType

func (c *HtmlColorer) PrimitiveType(t token.TypeSymbolToken)

func (*HtmlColorer) PrimitiveTypeName

func (c *HtmlColorer) PrimitiveTypeName(t *ast.TypeIdentifier)

func (*HtmlColorer) RecordField

func (c *HtmlColorer) RecordField(t token.VariableSymbolToken)

func (*HtmlColorer) RecordTypeField

func (c *HtmlColorer) RecordTypeField(t *dectype.RecordField)

func (*HtmlColorer) RightArrow

func (c *HtmlColorer) RightArrow()

func (*HtmlColorer) RightPipe

func (c *HtmlColorer) RightPipe()

func (*HtmlColorer) String

func (c *HtmlColorer) String() string

func (*HtmlColorer) StringLiteral

func (c *HtmlColorer) StringLiteral(s token.StringToken)

func (*HtmlColorer) TypeGeneratorName

func (c *HtmlColorer) TypeGeneratorName(t token.TypeSymbolToken)

func (*HtmlColorer) TypeSymbol

func (c *HtmlColorer) TypeSymbol(t token.TypeSymbolToken)

func (*HtmlColorer) UnmanagedName

func (c *HtmlColorer) UnmanagedName(t *ast.UnmanagedType)

func (*HtmlColorer) UserInstruction

func (c *HtmlColorer) UserInstruction(t string)

func (*HtmlColorer) VariableSymbol

func (c *HtmlColorer) VariableSymbol(t token.VariableSymbolToken)