parser

Documentation

Index

• Constants
• type Comment
• type Document
  • func Load(filename string) (*Document, error)
• type Node
• type Property
• type Section
• type Type
  • func (t Type) SchemaString() string
  • func (t Type) String() string

Constants

const (
	TagSection  = "docs:section"
	TagIgnore   = "docs:ignore"
	TagType     = "docs:type"
	TagDefault  = "docs:default"
	TagProperty = "docs:property"
)

Types

type Comment

type Comment struct {
	heuristics.CommentBlock
	Tags tags
}

type Document

type Document struct {
	Sections []Section
}

func Load

func Load(filename string) (*Document, error)

type Node

type Node struct {
	Path         paths.Path
	HeadComments []Comment
	FootComment  []Comment
	RawNode      *yaml.Node
}

type Property

type Property struct {
	Path        paths.Path
	Description Comment
	Type        Type
	Default     string
}

type Section

type Section struct {
	Name        string
	Description Comment
	Properties  []Property
}

type Type

type Type string

const (
	TypeUnknown   Type = "unknown"
	TypeString    Type = "string"
	TypeNumber    Type = "number"
	TypeBool      Type = "bool"
	TypeTimestamp Type = "timestamp"
	TypeArray     Type = "array"
	TypeObject    Type = "object"
)

func (Type) SchemaString

func (t Type) SchemaString() string

func (Type) String

func (t Type) String() string