mirror of
https://github.com/golang/go
synced 2024-11-26 13:18:19 -07:00
5268119f26
- A note doesn't have to be in the first comment of a comment group anymore, and several notes may appear in the same comment group (e.g., it is fairly common to have a TODO(uid) note immediately following another comment). - Define a doc.Note type which also contains note uid and position info. - Better formatting in godoc output. The position information is not yet used, but could be used to locate the note in the source text if desired. Fixes #4843. R=r, cnicolaou CC=gobot, golang-dev https://golang.org/cl/7496048
82 lines
1.9 KiB
Plaintext
82 lines
1.9 KiB
Plaintext
{{with .PAst}}{{node . $.FSet}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{with .PDoc}}{{if $.IsMain}}COMMAND DOCUMENTATION
|
|
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{else}}PACKAGE DOCUMENTATION
|
|
|
|
package {{.Name}}
|
|
import "{{.ImportPath}}"
|
|
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{example_text "" $.Examples $.FSet " "}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{with .Consts}}
|
|
CONSTANTS
|
|
|
|
{{range .}}{{node .Decl $.FSet}}
|
|
{{comment_text .Doc " " "\t"}}{{end}}
|
|
{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{with .Vars}}
|
|
VARIABLES
|
|
|
|
{{range .}}{{node .Decl $.FSet}}
|
|
{{comment_text .Doc " " "\t"}}{{end}}
|
|
{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{with .Funcs}}
|
|
FUNCTIONS
|
|
|
|
{{range .}}{{node .Decl $.FSet}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{example_text .Name $.Examples $.FSet " "}}
|
|
{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{with .Types}}
|
|
TYPES
|
|
|
|
{{range .}}{{$tname := .Name}}{{node .Decl $.FSet}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{range .Consts}}{{node .Decl $.FSet}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{end}}{{range .Vars}}{{node .Decl $.FSet}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{end}}{{example_text .Name $.Examples $.FSet " "}}
|
|
{{range .Funcs}}{{node .Decl $.FSet}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{example_text .Name $.Examples $.FSet " "}}
|
|
{{end}}{{range .Methods}}{{node .Decl $.FSet}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{$name := printf "%s_%s" $tname .Name}}{{example_text $name $.Examples $.FSet " "}}
|
|
{{end}}{{end}}{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{with $.Notes}}
|
|
{{range $marker, $content := .}}
|
|
{{$marker}}S
|
|
|
|
{{range $content}}{{comment_text .Body " " "\t"}}
|
|
{{end}}{{end}}{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{with .Dirs}}
|
|
SUBDIRECTORIES
|
|
{{if $.DirFlat}}{{range .List}}{{if .HasPkg}}
|
|
{{.Path}}{{end}}{{end}}
|
|
{{else}}{{range .List}}
|
|
{{repeat `. ` .Depth}}{{.Name}}{{end}}
|
|
{{end}}{{end}}
|