docs

Documentation

Overview

Package docs provides documentation extraction for source files referenced by ctx when the --doc flag is used.

Index

• type Collector
  • func NewCollector(repositoryRoot string) (*Collector, error)
  • func NewCollectorWithOptions(repositoryRoot string, options CollectorOptions) (*Collector, error)
  • func (collector *Collector) ActivateRemoteDocumentation(ctx context.Context)
  • func (collector *Collector) CollectFromFile(filePath string) ([]types.DocumentationEntry, error)
• type CollectorOptions
• type RemoteAttemptOptions
• type RemoteDocumentationAttempt
  • func (attempt *RemoteDocumentationAttempt) Activate(ctx context.Context)
  • func (attempt *RemoteDocumentationAttempt) DocumentationForImport(importPath string) []types.DocumentationEntry

Types

type Collector

type Collector struct {
	// contains filtered or unexported fields
}

Collector routes documentation lookups to language-specific extractors.

func NewCollector

func NewCollector(repositoryRoot string) (*Collector, error)

NewCollector creates a Collector using the repository root that contains go.mod.

func NewCollectorWithOptions

func NewCollectorWithOptions(repositoryRoot string, options CollectorOptions) (*Collector, error)

NewCollectorWithOptions creates a Collector with the supplied options.

func (*Collector) ActivateRemoteDocumentation

func (collector *Collector) ActivateRemoteDocumentation(ctx context.Context)

ActivateRemoteDocumentation stores the context used for remote lookups.

func (*Collector) CollectFromFile

func (collector *Collector) CollectFromFile(filePath string) ([]types.DocumentationEntry, error)

CollectFromFile returns documentation entries for the provided source file.

type CollectorOptions

type CollectorOptions struct {
	RemoteAttempt RemoteAttemptOptions
}

CollectorOptions configures optional documentation providers.

type RemoteAttemptOptions

type RemoteAttemptOptions struct {
	Enabled            bool
	APIBase            string
	AuthorizationToken string
}

RemoteAttemptOptions configures remote documentation lookup for third-party modules.

type RemoteDocumentationAttempt

type RemoteDocumentationAttempt struct {
	// contains filtered or unexported fields
}

RemoteDocumentationAttempt resolves documentation from GitHub for imported modules.

func (*RemoteDocumentationAttempt) Activate

func (attempt *RemoteDocumentationAttempt) Activate(ctx context.Context)

Activate stores the context that will be used for remote lookups.

func (*RemoteDocumentationAttempt) DocumentationForImport

func (attempt *RemoteDocumentationAttempt) DocumentationForImport(importPath string) []types.DocumentationEntry

DocumentationForImport returns remote documentation entries for the import path.