Categorygithub.com/rglyons/kube-arangodbdepsgolang.orgxtoolsgodoc
package
0.0.0-20180911130330-d3ccc4fb1d66
Repository: https://github.com/rglyons/kube-arangodb.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
39
Dependents
0
Files
5.2k SLOC

# README

godoc

This directory contains most of the code for running a godoc server. The executable lives at golang.org/x/tools/cmd/godoc.

Development mode

In production, CSS/JS/template assets need to be compiled into the godoc binary. It can be tedious to recompile assets every time, but you can pass a flag to load CSS/JS/templates from disk every time a page loads:

godoc -templates=$GOPATH/src/golang.org/x/tools/godoc/static -http=:6060

Recompiling static assets

The files that live at static/style.css, static/jquery.js and so on are not present in the final binary. They are placed into static/static.go by running go generate. So to compile a change and test it in your browser:

  1. Make changes to e.g. static/style.css.

  2. Run go generate golang.org/x/tools/godoc/static so static/static.go picks up the change.

  3. Run go install golang.org/x/tools/cmd/godoc so the compiled godoc binary picks up the change.

  4. Run godoc -http=:6060 and view your changes in the browser. You may need to disable your browser's cache to avoid reloading a stale file.

# Packages

Package analysis performs type and pointer analysis and generates mark-up for the Go source view.
Package redirect provides hooks to register HTTP handlers that redirect old godoc paths to their new equivalents and assist in accessing the issue tracker, wiki, code review system, etc.
Package static exports a map of static file content that supports the godoc user interface.
Package util contains utility types and functions for godoc.
Package vfs defines types for abstract file system access and provides an implementation accessing the file system of the underlying OS.

# Functions

CommandLine returns godoc results to w.
FormatSelections takes a text and writes it to w using link and segment writers lw and sw as follows: lw is invoked for consecutive segment starts and ends as specified through the links selection, and sw is invoked for consecutive segments of text overlapped by the same selections as specified by selections.
FormatText HTML-escapes text and writes it to w.
No description provided by the author
LinkifyText HTML-escapes source text and writes it to w.
NewCorpus returns a new Corpus from a filesystem.
NewPresentation returns a new Presentation from a corpus.
NewSnippet creates a text snippet from a declaration decl containing an identifier id.
RangeSelection computes the Selection for a text range described by the argument str; the range description must match the selRx regular expression.

# Constants

show all embedded methods.
No description provided by the author
show directory in a flat (non-indented) manner.
No description provided by the author
No description provided by the author
No description provided by the author
do not filter exports.
show result in textual form, do not generate HTML.
don't associate consts, vars, and factory functions with types.
No description provided by the author
query string where PageInfoMode is stored.
show source code, do not extract documentation.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author

# Structs

An AltWords describes a list of alternative spellings for a canonical (all lowercase) spelling of a word.
A Corpus holds all the state related to serving and indexing a collection of Go code.
No description provided by the author
DirEntry describes a directory entry.
No description provided by the author
A File describes a Go file.
A FileLines value specifies a file and line numbers within that file.
A FileRun is a list of KindRuns belonging to the same file.
Ident stores information about external identifiers in order to create links to package documentation.
No description provided by the author
An Indexer maintains the data structures and provides the machinery for indexing .go files under a file tree.
No description provided by the author
No description provided by the author
TODO(adg): why are some exported and some aren't? -brad.
Page
Page describes the contents of the top-level godoc webpage.
No description provided by the author
A Pak describes a Go package.
A PakRun describes a run of *FileRuns of a package.
Presentation generates output from a corpus.
No description provided by the author
A Segment describes a text segment [start, end).
No description provided by the author
A Spot describes a single occurrence of a word.
Statistics provides statistics information for an index.

# Type aliases

A HitList describes a list of PakRuns.
A KindRun is a run of SpotInfos of the same kind in a given file.
A LinkWriter writes some start or end "tag" to w for the text offset offs.
No description provided by the author
A RunList is a list of entries that can be sorted according to some criteria.
SearchResultFunc functions return an HTML body for displaying search results.
A SegmentWriter formats a text according to selections and writes it to w.
A Selection is an "iterator" function returning a text segment.
A SpotInfo value describes a particular identifier spot in a given file; It encodes three values: the SpotKind (declaration or use), a line or snippet index "lori", and whether it's a line or index.
SpotKind describes whether an identifier is declared (and what kind of declaration) or used.