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

doc

package

Go to main page

Versions in this module

v0

v0.1.2

Feb 22, 2024

v0.1.1

Feb 22, 2024

v0.0.11

Jul 22, 2022

v0.0.10

Jul 22, 2022

v0.0.9

Jul 22, 2022

v0.0.8

Jul 22, 2022

Changes in this version

type Package

+ func (p *Package) PathSplit() []string

+ func (p Package) PathIndent() func(string) string

v0.0.7

Jul 7, 2022

v0.0.6

Jul 7, 2022

v0.0.5

Jul 7, 2022

Changes in this version

type Func

+ func NewFunc(node *doc.Func, path string) *Func

type FuncVar

+ Pointer bool

v0.0.4

Jul 6, 2022

Changes in this version

type Type

+ func (t *Type) GetHeadingHREF() string

v0.0.3

Jul 6, 2022

Changes in this version

type Func

+ Params []FuncVar

+ Recv FuncVar

+ Results []FuncVar

+ func (f *Func) FormatParams() string

+ func (f *Func) FormatParamsBrackets() string

+ func (f *Func) FormatResults() string

+ func (f *Func) FormatResultsBrackets() string

+ func (f *Func) GetHeadingHREF() string

+ type FuncVar struct

+ Name string

+ Type string

v0.0.2

May 6, 2022

v0.0.1

Apr 21, 2022

Changes in this version

+ func AddConst(data *Package, node *doc.Value, path string)

+ func AddExample(data *Package, node *doc.Example, path string)

+ func AddFunc(data *Package, node *doc.Func, path string)

+ func AddFuncExample(data *Func, node *doc.Example, path string)

+ func AddType(data *Package, node *doc.Type, path string)

+ func AddTypeExample(data *Type, node *doc.Example, path string)

+ func AddTypeFunc(data *Type, node *doc.Func, path string)

+ func AddTypeMethod(data *Type, node *doc.Func, path string)

+ func AddVar(data *Package, node *doc.Value, path string)

+ func GetDirectories(path string) []string

+ func GetGoFiles(path string) []*ast.File

+ func GetGoFilesInDir(path string) []*ast.File

+ func GetPackageDocumentation(packageFilePath, packageImportPath string) (*doc.Package, error)

+ func GetPackagesDataFromDirRecursive(dirPath string, includeRoot bool, rootImportPath string) (map[string]*Package, error)

+ func ParseGoMod(pkg *Package, path string) error

+ func ParseGoModFile(module *Module, path string) error

+ func SeekGoMod(pkg *Package, path string, levels int) error

+ type Const struct

+ Definition string

+ Doc string

+ Filename string

+ Line int

+ Name string

+ type Example struct

+ Definition string

+ Doc string

+ Name string

+ type Func struct

+ Definition string

+ Doc string

+ Examples []*Example

+ Filename string

+ Line int

+ Name string

+ type Module struct

+ GoVersion string

+ Heading string

+ ImportPath string

+ Name string

+ Overview string

+ Submodules map[string]*Package

+ func ParseModule(path string) (*Module, error)

+ type Package struct

+ Constants []*Const

+ CustomVars map[string]string

+ Definition string

+ Doc string

+ Examples []*Example

+ Funcs []*Func

+ ImportPath string

+ Name string

+ Path string

+ PathAbs string

+ ShowConsts bool

+ ShowDoc bool

+ ShowExamples bool

+ ShowFuncs bool

+ ShowImportPath bool

+ ShowIndex bool

+ ShowName bool

+ ShowOverview bool

+ ShowSubpackages bool

+ ShowTypes bool

+ ShowVars bool

+ Subpackages map[string]*Package

+ Types []*Type

+ Vars []*Var

+ func GetPackageDataFromDir(path string) (*Package, error)

+ func GetPackageDataFromDirRecursive(path string) (*Package, error)

+ func ParsePackage(docs *doc.Package, path string) (*Package, error)

+ type Type struct

+ Definition string

+ Doc string

+ Examples []*Example

+ Filename string

+ Funcs []*Func

+ Line int

+ Methods []*Func

+ Name string

+ type Var struct

+ Definition string

+ Doc string

+ Filename string

+ Line int

+ Name string