doc

Documentation

Index

• Constants
• func Format(out io.StringWriter, lib Lib)
• type Arg
• type Const
• type Fn
• type Lib
  • func Parse(name string, file []byte) Lib
• type Struct

Constants

const (
	TAG_EMPTY     = "/// "
	TAG_EXISTS    = "/// @"
	TAG_FUNC      = "/// @func "
	TAG_ARG       = "/// @arg"
	TAG_ARG_REQ   = "/// @arg "
	TAG_ARG_OPT   = "/// @arg? "
	TAG_RETURNS   = "/// @returns "
	TAG_CONSTANTS = "/// @constants "
	TAG_CONST     = "/// @const "
	TAG_BLOCK     = "/// @blocking"
	TAG_DESC      = "/// @desc"
	TAG_STRUCT    = "/// @struct "
	TAG_PROP      = "/// @prop "
	TAG_METHOD    = "/// @method "
)

Functions

func Format

func Format(out io.StringWriter, lib Lib)

Types

type Arg

type Arg struct {
	Str string
	Opt bool
}

type Const

type Const struct {
	Group  string
	Consts []string
}

type Fn

type Fn struct {
	Fn      string
	Args    []Arg
	Returns []string
	Block   bool
	Desc    []string
}

type Lib

type Lib struct {
	Name string
	Fns  []Fn
	Cns  []Const
	Sts  []Struct
}

func Parse

func Parse(name string, file []byte) Lib

type Struct

type Struct struct {
	Struct  string
	Props   []string
	Methods []string
	Desc    []string
}