comments

Documentation

Index

• func ParseDocs(c ParseDocsConfig) ([]config.RawConverter, error)
• type Converter
• type ParseDocsConfig

Functions

func ParseDocs

func ParseDocs(c ParseDocsConfig) ([]config.RawConverter, error)

ParseDocs parses the docs for the given pattern.

Types

type Converter

type Converter struct {
	Name     string
	Comments config.RawLines
	Methods  map[string]config.RawLines
	Scope    *types.Scope
}

Converter defines a converter that was marked with converterMarker.

type ParseDocsConfig

type ParseDocsConfig struct {
	// PackagePatterns are golang package patterns to scan, required.
	PackagePattern []string
	// WorkingDir is a directory to invoke the tool on. If omitted, current directory is used.
	WorkingDir string
	BuildTags  string
}

ParseDocsConfig provides input to the ParseDocs method below.