mirror of
https://github.com/golang/go
synced 2024-11-18 16:14:46 -07:00
473fd854f8
Running 'godoc -src' would end up with concatenated sources:
$ godoc -src github.com/bradfitz/http2 Frame
// a frameParser parses a frame given its FrameHeader and payload
// bytes. The length of payload will always equal fh.Length (which
// might be 0).
type frameParser func(fh FrameHeader, payload []byte) (Frame, error)//
A Frame is the base interface implemented by all frame types.
// Callers will generally type-assert the specific frame type:
// *HeadersFrame, *SettingsFrame, *WindowUpdateFrame, etc.
//
// Frames are only valid until the next call to Framer.ReadFrame.
type Frame interface {
Unconditionnally insert two newlines:
$ godoc -src github.com/bradfitz/http2 Frame
// a frameParser parses a frame given its FrameHeader and payload
// bytes. The length of payload will always equal fh.Length (which
// might be 0).
type frameParser func(fh FrameHeader, payload []byte) (Frame, error)
// A Frame is the base interface implemented by all frame types.
// Callers will generally type-assert the specific frame type:
// *HeadersFrame, *SettingsFrame, *WindowUpdateFrame, etc.
//
// Frames are only valid until the next call to Framer.ReadFrame.
type Frame interface {
Fixes #9726.
Change-Id: I51ee04e53d4962c890ea601125eda8fce84d6a46
Reviewed-on: https://go-review.googlesource.com/7681
Reviewed-by: Robert Griesemer <gri@golang.org>
117 lines
2.9 KiB
Plaintext
117 lines
2.9 KiB
Plaintext
{{$info := .}}{{$filtered := .IsFiltered}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{if $filtered}}{{range .PAst}}{{range .Decls}}{{node $info .}}
|
|
|
|
{{end}}{{end}}{{else}}{{with .PAst}}{{range $filename, $ast := .}}{{$filename}}:
|
|
{{node $ $ast}}{{end}}{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{if and $filtered (not (or .PDoc .PAst))}}No match found.
|
|
{{end}}{{with .PDoc}}{{if $.IsMain}}COMMAND DOCUMENTATION
|
|
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{else}}{{if not $filtered}}PACKAGE DOCUMENTATION
|
|
|
|
package {{.Name}}
|
|
import "{{.ImportPath}}"
|
|
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{example_text $ "" " "}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{with .Consts}}{{if not $filtered}}CONSTANTS
|
|
|
|
{{end}}{{range .}}{{node $ .Decl}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{with .Vars}}{{if not $filtered}}VARIABLES
|
|
|
|
{{end}}{{range .}}{{node $ .Decl}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{with .Funcs}}{{if not $filtered}}FUNCTIONS
|
|
|
|
{{end}}{{range .}}{{node $ .Decl}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{example_text $ .Name " "}}{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{with .Types}}{{if not $filtered}}TYPES
|
|
|
|
{{end}}{{range .}}{{$tname := .Name}}{{node $ .Decl}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{if .Consts}}{{range .Consts}}{{node $ .Decl}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{if .Vars}}{{range .Vars}}{{node $ .Decl}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{range $name := .Names}}{{example_text $ $name " "}}{{end}}{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{if .Funcs}}{{range .Funcs}}{{node $ .Decl}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{example_text $ .Name " "}}{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{if .Methods}}{{range .Methods}}{{node $ .Decl}}
|
|
{{comment_text .Doc " " "\t"}}
|
|
{{$name := printf "%s_%s" $tname .Name}}{{example_text $ $name " "}}{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{if and $filtered (not (or .Consts (or .Vars (or .Funcs .Types))))}}No match found.
|
|
{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{with $.Notes}}
|
|
{{range $marker, $content := .}}
|
|
{{$marker}}S
|
|
|
|
{{range $content}}{{comment_text .Body " " "\t"}}
|
|
{{end}}{{end}}{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{if not $filtered}}{{with .Dirs}}SUBDIRECTORIES
|
|
{{if $.DirFlat}}{{range .List}}{{if .HasPkg}}
|
|
{{.Path}}{{end}}{{end}}
|
|
{{else}}{{range .List}}
|
|
{{repeat `. ` .Depth}}{{.Name}}{{end}}
|
|
{{end}}{{end}}{{/*
|
|
|
|
---------------------------------------
|
|
|
|
*/}}{{end}}{{/*
|
|
Make sure there is no newline at the end of this file.
|
|
perl -i -pe 'chomp if eof' package.txt
|
|
*/}}
|