Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

lang

package

Go to main page

Versions in this module

v0

v0.5.4

Dec 24, 2022

v0.5.3

Dec 21, 2022

Changes in this version

+ var GOPRIVATE = os.Getenv("GOPRIVATE")

type Config

+ func (c *Config) DocLinkURL(link *comment.DocLink) string

v0.5.2

Dec 20, 2022

v0.5.1

Dec 20, 2022

v0.5.0

Dec 19, 2022

v0.4.4

Dec 19, 2022

v0.4.3

Dec 19, 2022

v0.4.2

Dec 16, 2022

Changes in this version

+ type Block struct

+ func NewBlock(cfg *Config, kind BlockKind, text string) *Block

+ func (b *Block) Kind() BlockKind

+ func (b *Block) Level() int

+ func (b *Block) Text() string

+ type BlockKind string

+ const CodeBlock

+ const HeaderBlock

+ const ParagraphBlock

+ type Config struct

+ FileSet *token.FileSet

+ Level int

+ Log logger.Logger

+ PkgDir string

+ Repo *Repo

+ WorkDir string

+ func NewConfig(log logger.Logger, workDir string, pkgDir string, opts ...ConfigOption) (*Config, error)

+ func (c *Config) Inc(step int) *Config

+ type ConfigOption func(c *Config) error

+ func ConfigWithRepoOverrides(overrides *Repo) ConfigOption

+ type Doc struct

+ func NewDoc(cfg *Config, text string) *Doc

+ func (d *Doc) Blocks() []*Block

+ func (d *Doc) Level() int

+ type Example struct

+ func NewExample(cfg *Config, name string, doc *doc.Example) *Example

+ func (ex *Example) Code() (string, error)

+ func (ex *Example) Doc() *Doc

+ func (ex *Example) HasOutput() bool

+ func (ex *Example) Level() int

+ func (ex *Example) Location() Location

+ func (ex *Example) Name() string

+ func (ex *Example) Output() string

+ func (ex *Example) Summary() string

+ func (ex *Example) Title() string

+ type File struct

+ Footer string

+ Header string

+ Packages []*Package

+ func NewFile(header, footer string, packages []*Package) *File

+ type Func struct

+ func NewFunc(cfg *Config, doc *doc.Func, examples []*doc.Example) *Func

+ func (fn *Func) Doc() *Doc

+ func (fn *Func) Examples() (examples []*Example)

+ func (fn *Func) Level() int

+ func (fn *Func) Location() Location

+ func (fn *Func) Name() string

+ func (fn *Func) Receiver() string

+ func (fn *Func) Signature() (string, error)

+ func (fn *Func) Summary() string

+ func (fn *Func) Title() string

+ type Location struct

+ End Position

+ Filepath string

+ Repo *Repo

+ Start Position

+ WorkDir string

+ func NewLocation(cfg *Config, node ast.Node) Location

+ type Package struct

+ func NewPackage(cfg *Config, doc *doc.Package, examples []*doc.Example) *Package

+ func NewPackageFromBuild(log logger.Logger, pkg *build.Package, opts ...PackageOption) (*Package, error)

+ func (pkg *Package) Consts() (consts []*Value)

+ func (pkg *Package) Dir() string

+ func (pkg *Package) Dirname() string

+ func (pkg *Package) Doc() *Doc

+ func (pkg *Package) Examples() (examples []*Example)

+ func (pkg *Package) Funcs() (funcs []*Func)

+ func (pkg *Package) Import() string

+ func (pkg *Package) ImportPath() string

+ func (pkg *Package) Level() int

+ func (pkg *Package) Name() string

+ func (pkg *Package) Summary() string

+ func (pkg *Package) Types() (types []*Type)

+ func (pkg *Package) Vars() (vars []*Value)

+ type PackageOption func(opts *PackageOptions) error

+ func PackageWithRepositoryOverrides(repo *Repo) PackageOption

+ func PackageWithUnexportedIncluded() PackageOption

+ type PackageOptions struct

+ type Position struct

+ Col int

+ Line int

+ type Repo struct

+ DefaultBranch string

+ PathFromRoot string

+ Remote string

+ type Type struct

+ func NewType(cfg *Config, doc *doc.Type, examples []*doc.Example) *Type

+ func (typ *Type) Consts() []*Value

+ func (typ *Type) Decl() (string, error)

+ func (typ *Type) Doc() *Doc

+ func (typ *Type) Examples() (examples []*Example)

+ func (typ *Type) Funcs() []*Func

+ func (typ *Type) Level() int

+ func (typ *Type) Location() Location

+ func (typ *Type) Methods() []*Func

+ func (typ *Type) Name() string

+ func (typ *Type) Summary() string

+ func (typ *Type) Title() string

+ func (typ *Type) Vars() []*Value

+ type Value struct

+ func NewValue(cfg *Config, doc *doc.Value) *Value

+ func (v *Value) Decl() (string, error)

+ func (v *Value) Doc() *Doc

+ func (v *Value) Level() int

+ func (v *Value) Location() Location

+ func (v *Value) Summary() string