dochtml

Documentation

Overview

Package dochtml generates html for godochtml.

Index

• func DefaultTemplate() string
• func Write(w io.Writer, p *doc.Package, fset *token.FileSet, tpl string, ...) error
• type FileLinker
  • func (f *FileLinker) Set(v string) error
  • func (f *FileLinker) String() string
  • func (f *FileLinker) URL(file string) (string, bool)
• type Functions
  • func (f *Functions) Map() map[string]interface{}
• type Highlighter
  • func (h *Highlighter) HTML(s string) string
  • func (h *Highlighter) String(s string) string
  • func (h *Highlighter) Styles() (template.CSS, error)

Functions

func DefaultTemplate

func DefaultTemplate() string

DefaultTemplate returns the default HTML template used by godochtml. nolint: lll, funlen

func Write

func Write(w io.Writer, p *doc.Package, fset *token.FileSet, tpl string, linker *FileLinker) error

Write generates the html for a specific package using the provided template. If no template is provided, the default template is chosen..

Types

type FileLinker

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

FileLinker linkifies source files.

func (*FileLinker) Set

func (f *FileLinker) Set(v string) error

Set parses a regexp=replacemennt pattern and appends to the list.

func (*FileLinker) String

func (f *FileLinker) String() string

String is not yet implemented.

func (*FileLinker) URL

func (f *FileLinker) URL(file string) (string, bool)

URL converts a file path to an url.

type Functions

type Functions struct {
	*doc.Package
	*token.FileSet
	*FileLinker
}

Functions builds out the standard functions needed by the html template.

func (*Functions) Map

func (f *Functions) Map() map[string]interface{}

Map returns the default function map

type Highlighter

type Highlighter struct {
}

Highlighter implements syntax highlighting.

func (*Highlighter) HTML

func (h *Highlighter) HTML(s string) string

HTML scans the HTML for `pre` tags, converting these to highlighted HTML.

func (*Highlighter) String

func (h *Highlighter) String(s string) string

Code converts a static into highlighted HTML.

func (*Highlighter) Styles

func (h *Highlighter) Styles() (template.CSS, error)

Styles returns a <style> node with appropriate classes