doc

package
Version: v0.0.0-...-0469269 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 8, 2015 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const FILE_TEMPLATE_STR = `` /* 1159-byte string literal not displayed */
View Source
const INDEX_TEMPLATE_STR = `` /* 329-byte string literal not displayed */
View Source
const STYLE = `` /* 318-byte string literal not displayed */

Variables

This section is empty.

Functions

This section is empty.

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
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL