Versions in this module Expand all Collapse all v1 v1.0.0 Mar 21, 2024 Changes in this version + func PackageSymbols(pkg *doc.Package) map[string]Symbol + type Block struct + func NewBlock(cfg *Config, kind BlockKind, spans []*Span, inline bool) *Block + func NewListBlock(cfg *Config, list *List, inline bool) *Block + func ParseBlocks(cfg *Config, blocks []comment.Block, inline bool) []*Block + func (b *Block) Inline() bool + func (b *Block) Kind() BlockKind + func (b *Block) Level() int + func (b *Block) List() *List + func (b *Block) Spans() []*Span + type BlockKind string + const CodeBlock + const HeaderBlock + const ListBlock + const ParagraphBlock + type Config struct + FileFilter *string + FileSet *token.FileSet + Files []*ast.File + Level int + Log logger.Logger + OverrideImport *string + Pkg *doc.Package + PkgDir string + Repo *Repo + Symbols map[string]Symbol + 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 ConfigWithFileFilter(fileFilter *string) ConfigOption + func ConfigWithOverrideImport(importPath *string) ConfigOption + 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) Anchor() string + 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 Item struct + func NewItem(cfg *Config, docItem *comment.ListItem) *Item + func (i *Item) Blocks() []*Block + func (i *Item) Kind() ItemKind + func (i *Item) Number() int + type ItemKind string + const OrderedItem + const UnorderedItem + type List struct + func NewList(cfg *Config, docList *comment.List) *List + func (l *List) BlankBetween() bool + func (l *List) Items() []*Item + 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, 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 PackageWithFileFilter(file string) PackageOption + func PackageWithOverrideImport(importPath string) PackageOption + 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 Span struct + func NewSpan(cfg *Config, kind SpanKind, text string, url string) *Span + func ParseSpans(cfg *Config, texts []comment.Text) []*Span + func (s *Span) Kind() SpanKind + func (s *Span) Text() string + func (s *Span) URL() string + type SpanKind string + const AutolinkSpan + const LinkSpan + const RawTextSpan + const TextSpan + type Symbol struct + Kind SymbolKind + Name string + Parent *Symbol + Receiver string + func (s Symbol) Anchor() string + type SymbolKind int + const ConstSymbolKind + const FieldSymbolKind + const FuncSymbolKind + const MethodSymbolKind + const TypeSymbolKind + const VarSymbolKind + type Type struct + func NewType(cfg *Config, doc *doc.Type, examples []*doc.Example) *Type + func (typ *Type) Anchor() string + 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) Anchor() string + 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