utils

Documentation

Index

• Constants
• type Document
  • func NewDocumet(secs []Section) Document
  • func (doc Document) WriteDocument(file string) (err error)
• type Section
  • func NewSection(name string, subs []Subsection) Section
  • func (sec Section) WriteSection(fd *os.File)
• type Subsection
  • func NewSubsection(name string, table Table) Subsection
• type Table
  • func NewTable(header []string, data [][]string, name string) Table
  • func (T *Table) String() string
  • func (T *Table) WriteToFile(fd *os.File) (err error)

Constants

const BEGING_MARK string = "<!-- BEGIN_PDOCS -->"

const END_MARK string = "<!-- END_PDOCS -->"

Types

type Document

type Document struct {
	Name     string
	Sections []Section
}

func NewDocumet

func NewDocumet(secs []Section) Document

func (Document) WriteDocument

func (doc Document) WriteDocument(file string) (err error)

type Section

type Section struct {
	Name        string
	Subsections []Subsection
}

func NewSection

func NewSection(name string, subs []Subsection) Section

func (Section) WriteSection

func (sec Section) WriteSection(fd *os.File)

type Subsection

type Subsection struct {
	Name  string
	Table Table
}

func NewSubsection

func NewSubsection(name string, table Table) Subsection

type Table

type Table struct {
	// contains filtered or unexported fields
}

func NewTable

func NewTable(header []string, data [][]string, name string) Table

func (*Table) String

func (T *Table) String() string

func (*Table) WriteToFile

func (T *Table) WriteToFile(fd *os.File) (err error)