From 04341b246e14608472527f73577f46024e6c3ec1 Mon Sep 17 00:00:00 2001 From: Robert Griesemer Date: Thu, 28 Mar 2013 13:05:30 -0700 Subject: [PATCH] cmd/godoc: cleanups - removed gratuitous empty lines that creeped into command line output - changed comment color to a dark green so that links don't visually melt into them - removed some TODOs - updated doc.go R=golang-dev, bradfitz CC=golang-dev https://golang.org/cl/8108044 --- doc/style.css | 2 +- lib/godoc/package.txt | 15 +++++++-------- src/cmd/godoc/doc.go | 2 ++ src/cmd/godoc/index.go | 2 -- src/cmd/godoc/utils.go | 2 -- 5 files changed, 10 insertions(+), 13 deletions(-) diff --git a/doc/style.css b/doc/style.css index 3d881b03a7..6ab9afbdea 100644 --- a/doc/style.css +++ b/doc/style.css @@ -12,7 +12,7 @@ pre { line-height: 18px; } pre .comment { - color: #375EAB; + color: #006600; } pre .highlight, pre .highlight-comment, diff --git a/lib/godoc/package.txt b/lib/godoc/package.txt index 407be57875..d191621c00 100644 --- a/lib/godoc/package.txt +++ b/lib/godoc/package.txt @@ -19,8 +19,8 @@ package {{.Name}} CONSTANTS {{range .}}{{node $ .Decl}} -{{comment_text .Doc " " "\t"}}{{end}} -{{end}}{{/* +{{comment_text .Doc " " "\t"}} +{{end}}{{end}}{{/* --------------------------------------- @@ -28,8 +28,8 @@ CONSTANTS VARIABLES {{range .}}{{node $ .Decl}} -{{comment_text .Doc " " "\t"}}{{end}} -{{end}}{{/* +{{comment_text .Doc " " "\t"}} +{{end}}{{end}}{{/* --------------------------------------- @@ -38,8 +38,7 @@ FUNCTIONS {{range .}}{{node $ .Decl}} {{comment_text .Doc " " "\t"}} -{{example_text $ .Name " "}} -{{end}}{{end}}{{/* +{{example_text $ .Name " "}}{{end}}{{end}}{{/* --------------------------------------- @@ -58,8 +57,8 @@ TYPES {{example_text $ .Name " "}} {{end}}{{range .Methods}}{{node $ .Decl}} {{comment_text .Doc " " "\t"}} -{{$name := printf "%s_%s" $tname .Name}}{{example_text $ $name " "}} -{{end}}{{end}}{{end}}{{end}}{{/* +{{$name := printf "%s_%s" $tname .Name}}{{example_text $ $name " "}}{{end}} +{{end}}{{end}}{{end}}{{/* --------------------------------------- diff --git a/src/cmd/godoc/doc.go b/src/cmd/godoc/doc.go index e5f5324cd4..1fa57a8b31 100644 --- a/src/cmd/godoc/doc.go +++ b/src/cmd/godoc/doc.go @@ -61,6 +61,8 @@ The flags are: to the indexer (the indexer will never finish), a value of 1.0 means that index creation is running at full throttle (other goroutines may get no time while the index is built) + -links=true: + link identifiers to their declarations -write_index=false write index to a file; the file name must be specified with -index_files diff --git a/src/cmd/godoc/index.go b/src/cmd/godoc/index.go index 91c56461a3..8198fca0d0 100644 --- a/src/cmd/godoc/index.go +++ b/src/cmd/godoc/index.go @@ -651,8 +651,6 @@ func (x *Indexer) addFile(filename string, goFile bool) (file *token.File, ast * // makes sure that the important files are included and massively reduces the // number of files to index. The advantage over a blacklist is that unexpected // (non-blacklisted) files won't suddenly explode the index. -// -// TODO(gri): We may want to make this list customizable, perhaps via a flag. // Files are whitelisted if they have a file name or extension // present as key in whitelisted. diff --git a/src/cmd/godoc/utils.go b/src/cmd/godoc/utils.go index 7def015c8a..0cdb7ff7af 100644 --- a/src/cmd/godoc/utils.go +++ b/src/cmd/godoc/utils.go @@ -56,8 +56,6 @@ func isText(s []byte) bool { return true } -// TODO(gri): Should have a mapping from extension to handler, eventually. - // textExt[x] is true if the extension x indicates a text file, and false otherwise. var textExt = map[string]bool{ ".css": false, // must be served raw