godoc

Documentation

Overview

Package godoc includes a method to serve a given package path on a given port on localhost.

Index

• type Server
  • func DefaultServer(settings ...SettingsFunc) Server
• type Settings
• type SettingsFunc
  • func WithOpenBrowser(yesNo bool) SettingsFunc

Types

type Server

type Server interface {
	Serve(repoPath, packagePath string, port int) (err error)
}

Server starts a godoc server showing the given package path.

func DefaultServer

func DefaultServer(settings ...SettingsFunc) Server

DefaultServer returns a godoc.Server with default settings.

type Settings

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

BaseSettings holds settings for the godoc server.

type SettingsFunc

type SettingsFunc func(s *Settings)

SettingsFunc is a function mutating attributes inside a given BaseSettings-structure.

func WithOpenBrowser

func WithOpenBrowser(yesNo bool) SettingsFunc

WithOpenBrowser sets whether a browser should be opened.