docs

Documentation

Overview

Package docs provides the content of github pages at https://gregoryv.github.io/draw/

Index

• func AllShapes() *design.Diagram
• func ExampleActivityDiagram() *design.ActivityDiagram
• func ExampleC4SystemContextDiagram() *design.Diagram
• func ExampleClassDiagram() *design.ClassDiagram
• func ExampleDiagram() *design.Diagram
• func ExampleGanttChart() *design.GanttChart
• func ExampleSequenceDiagram() *design.SequenceDiagram
• func ExampleSmallClassDiagram() *design.ClassDiagram
• func LoadFile(filename string, span ...int) *Element
• func NewProjectArticle() *Element
• func NewProjectsPage() *Page
• func Theme() *CSS
• type Door
  • func (me *Door) Materials() []string
• type House
  • func (me *House) Rooms() int
• type Part
• type Window
  • func (me *Window) Materials() []string

Functions

func AllShapes

func AllShapes() *design.Diagram

func ExampleActivityDiagram

func ExampleActivityDiagram() *design.ActivityDiagram

func ExampleC4SystemContextDiagram

func ExampleC4SystemContextDiagram() *design.Diagram

func ExampleClassDiagram

func ExampleClassDiagram() *design.ClassDiagram

func ExampleDiagram

func ExampleDiagram() *design.Diagram

func ExampleGanttChart

func ExampleGanttChart() *design.GanttChart

func ExampleSequenceDiagram

func ExampleSequenceDiagram() *design.SequenceDiagram

func ExampleSmallClassDiagram

func ExampleSmallClassDiagram() *design.ClassDiagram

func LoadFile

func LoadFile(filename string, span ...int) *Element

LoadFile returns a pre web element wrapping the contents from the given file. If to == -1 all lines to the end of file are returned.

func NewProjectArticle

func NewProjectArticle() *Element

func NewProjectsPage

func NewProjectsPage() *Page

func Theme

func Theme() *CSS

Types

type Door

type Door struct {
	Material string
}

func (*Door) Materials

func (me *Door) Materials() []string

type House

type House struct {
	Frontdoor Door      // aggregation
	Windows   []*Window // composition
}

func (*House) Rooms

func (me *House) Rooms() int

type Part

type Part interface {
	Materials() []string
}

type Window

type Window struct {
	Model string
}

func (*Window) Materials

func (me *Window) Materials() []string