doc

package
Version: v0.0.0-...-8433dcb Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 2, 2020 License: BSD-3-Clause Imports: 9 Imported by: 1

Documentation

Overview

Package doc contains functions to generate the HTML User's Guide and the man page for the Go Doctor.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PrintInstallGuide

func PrintInstallGuide(aboutText string, flags *flag.FlagSet, out io.Writer)

PrintInstallGuide outputs the (HTML) Installation Guide for the Go Doctor.

func PrintManPage

func PrintManPage(aboutText string, flags *flag.FlagSet, out io.Writer)

PrintManPage outputs a man page for the godoctor command line tool.

func PrintUserGuide

func PrintUserGuide(aboutText string, flags *flag.FlagSet, out io.Writer)

PrintUserGuide outputs the User's Guide for the Go Doctor (in HTML).

Both the godoctor man page and the Vim plugin reference are generated and included in the User's Guide. The man page content is piped through groff to convert it to HTML.

func PrintUserGuideAsGiven

func PrintUserGuideAsGiven(aboutText string, flags *flag.FlagSet, ctnt *UserGuideContent, out io.Writer)

PrintUserGuideAsGiven outputs the User's Guide for the Go Doctor (in HTML). However, if the content's ManPageHTML and/or VimdocHTML is nonempty, the given content is used rather than generating the content. This is used by the online documentation, which cannot execute groff to convert the man page to HTML (due to an App Engine restriction), and which uses a Vim-colored version of the Vim plugin documentation.

func PrintVimdoc

func PrintVimdoc(aboutText string, flags *flag.FlagSet, out io.Writer)

PrintVimdoc outputs vimdoc documentation for the Go Doctor Vim plugin.

Types

type UserGuideContent

type UserGuideContent struct {
	ManPageHTML string
	VimdocHTML  string
	// contains filtered or unexported fields
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL