source

Documentation

Overview

Package source defines interfaces for generating URL links in documentation.

Index

• type LinkOptions
• type Linker
• type ScrapeChecker

Types

type LinkOptions

type LinkOptions struct {
	Line int
}

LinkOptions contains options for configuring hyperlinks to source files

type Linker

type Linker interface {
	LinkToSource(packagePath string, options LinkOptions) url.URL
}

Linker can generate hyperlinks for any given package's file

type ScrapeChecker

type ScrapeChecker interface {
	ShouldScrapePackage(packagePath string) bool
}

ScrapeChecker returns whether or not a given package's path should be scraped and included in the output