yuml

package

v0.0.0-...-d623aaa Latest Latest Go to latest Published: May 28, 2018 License: ISC Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

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

YUML errors

This section is empty.

type Attributes []xml.Attr

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

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

Child contains a YUML element and its parent-related attributes

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

Element contains all the data about a YUML element

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

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

func (y Element) String() string