Documentation ¶
Overview ¶
Package dochtml generates html for godochtml.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultTemplate ¶ added in v0.0.5
func DefaultTemplate() string
DefaultTemplate returns the default HTML template used by godochtml. nolint: lll, funlen
Types ¶
type FileLinker ¶ added in v0.0.6
type FileLinker struct {
// contains filtered or unexported fields
}
FileLinker linkifies source files.
func (*FileLinker) Set ¶ added in v0.0.6
func (f *FileLinker) Set(v string) error
Set parses a regexp=replacemennt pattern and appends to the list.
func (*FileLinker) String ¶ added in v0.0.6
func (f *FileLinker) String() string
String is not yet implemented.
type Functions ¶ added in v0.0.5
type Functions struct { *doc.Package *token.FileSet *FileLinker }
Functions builds out the standard functions needed by the html template.
type Highlighter ¶ added in v0.0.5
type Highlighter struct { }
Highlighter implements syntax highlighting.
func (*Highlighter) HTML ¶ added in v0.0.5
func (h *Highlighter) HTML(s string) string
HTML scans the HTML for `pre` tags, converting these to highlighted HTML.
func (*Highlighter) String ¶ added in v0.0.5
func (h *Highlighter) String(s string) string
Code converts a static into highlighted HTML.
Click to show internal directories.
Click to hide internal directories.