doc

Documentation

Index

• Constants
• type Decl
• type Docgen
  • func (v *Docgen) Generate(verbose bool)
• type File
• type FileTempData
• type IndexTempData

Constants

const FILE_TEMPLATE_STR = `` /* 1159-byte string literal not displayed */

const INDEX_TEMPLATE_STR = `` /* 329-byte string literal not displayed */

const STYLE = `` /* 318-byte string literal not displayed */

Types

type Decl

type Decl struct {
	Node       parser.Decl
	Docs       string
	ParsedDocs template.HTML // docs after markdown parsing
	Ident      string        // identifier
	Snippet    string        // code snippet of declaration
}

type Docgen

type Docgen struct {
	Input []*parser.File
	Dir   string
	// contains filtered or unexported fields
}

func (*Docgen) Generate

func (v *Docgen) Generate(verbose bool)

type File

type File struct {
	Name          string
	RootLoc       string // path from this file to the root directory (the directory containing index.html)
	VariableDecls []*Decl
	StructDecls   []*Decl
	FunctionDecls []*Decl
}

type FileTempData

type FileTempData struct {
	Name  string
	Decls []*Decl
}

type IndexTempData

type IndexTempData struct {
	Files []*File
}