yuml

Documentation

Index

• Variables
• type Attributes
• type Child
• type Element
  • func ParseYUML(reader io.Reader) (*Element, error)
  • func (y Element) String() string

Variables

var (
	ErrIncompleteYuml = errors.New("Incomplete YUML tree")
)

YUML errors

Types

type Attributes

type Attributes []xml.Attr

Attributes are YUML attributes (basically xml.Attr with some extra sugar)

type Child

type Child struct {
	Element  *Element
	Settings []xml.Attr
}

Child contains a YUML element and its parent-related attributes

type Element

type Element struct {
	Name       xml.Name
	Attributes Attributes
	Children   []Child
	Content    []byte
}

Element contains all the data about a YUML element

func ParseYUML

func ParseYUML(reader io.Reader) (*Element, error)

ParseYUML tries to read YUML code and parse it as such, returning the root element

func (Element) String

func (y Element) String() string