1
0
mirror of https://github.com/golang/go synced 2024-11-12 00:30:22 -07:00

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
This commit is contained in:
Robert Griesemer 2013-03-28 13:05:30 -07:00
parent 972cb4b442
commit 04341b246e
5 changed files with 10 additions and 13 deletions

View File

@ -12,7 +12,7 @@ pre {
line-height: 18px;
}
pre .comment {
color: #375EAB;
color: #006600;
}
pre .highlight,
pre .highlight-comment,

View File

@ -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}}{{/*
---------------------------------------

View File

@ -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

View File

@ -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.

View File

@ -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