qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-25 13:27:57 -07:00
Code Releases Activity
cd16b4f50d
go/lib/godoc/package.txt

84 lines
1.4 KiB
Plaintext
Raw Normal View History

godoc: fix lib/godoc/package.txt template - show documentation in text mode; e.g.: http://localhost:7777/cmd/godoc/?f=text - simplify template by using $ variable R=r, adg CC=golang-dev https://golang.org/cl/4873045
2011-08-15 16:42:27 -06:00
{{with .PAst}}{{node . $.FSet}}{{end}}{{/*
move godoc to src/cmd/godoc R=rsc DELTA=945 (944 added, 0 deleted, 1 changed) OCL=30315 CL=30341
2009-06-16 10:14:06 -06:00
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
---------------------------------------
godoc: fix lib/godoc/package.txt template - show documentation in text mode; e.g.: http://localhost:7777/cmd/godoc/?f=text - simplify template by using $ variable R=r, adg CC=golang-dev https://golang.org/cl/4873045
2011-08-15 16:42:27 -06:00
*/}}{{with .PDoc}}{{if $.IsPkg}}PACKAGE
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
package {{.PackageName}}
import "{{.ImportPath}}"
{{else}}COMMAND DOCUMENTATION
godoc: fix lib/godoc/package.txt template - show documentation in text mode; e.g.: http://localhost:7777/cmd/godoc/?f=text - simplify template by using $ variable R=r, adg CC=golang-dev https://golang.org/cl/4873045
2011-08-15 16:42:27 -06:00
{{end}}{{.Doc}}{{/*
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
---------------------------------------
*/}}{{with .Consts}}
move godoc to src/cmd/godoc R=rsc DELTA=945 (944 added, 0 deleted, 1 changed) OCL=30315 CL=30341
2009-06-16 10:14:06 -06:00
CONSTANTS
tweak the newlines so the headers stand out better. old: CONSTANTS const ( MissingKind = iota; ) new: CONSTANTS const ( MissingKind = iota; ) R=gri,rsc DELTA=4 (4 added, 0 deleted, 0 changed) OCL=30362 CL=30598
2009-06-22 15:18:23 -06:00
godoc: fix lib/godoc/package.txt template - show documentation in text mode; e.g.: http://localhost:7777/cmd/godoc/?f=text - simplify template by using $ variable R=r, adg CC=golang-dev https://golang.org/cl/4873045
2011-08-15 16:42:27 -06:00
{{range .}}{{node .Decl $.FSet}}
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
{{.Doc}}{{end}}
{{end}}{{/*
---------------------------------------
move godoc to src/cmd/godoc R=rsc DELTA=945 (944 added, 0 deleted, 1 changed) OCL=30315 CL=30341
2009-06-16 10:14:06 -06:00
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
*/}}{{with .Vars}}
move godoc to src/cmd/godoc R=rsc DELTA=945 (944 added, 0 deleted, 1 changed) OCL=30315 CL=30341
2009-06-16 10:14:06 -06:00
VARIABLES
tweak the newlines so the headers stand out better. old: CONSTANTS const ( MissingKind = iota; ) new: CONSTANTS const ( MissingKind = iota; ) R=gri,rsc DELTA=4 (4 added, 0 deleted, 0 changed) OCL=30362 CL=30598
2009-06-22 15:18:23 -06:00
godoc: fix lib/godoc/package.txt template - show documentation in text mode; e.g.: http://localhost:7777/cmd/godoc/?f=text - simplify template by using $ variable R=r, adg CC=golang-dev https://golang.org/cl/4873045
2011-08-15 16:42:27 -06:00
{{range .}}{{node .Decl $.FSet}}
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
{{.Doc}}{{end}}
{{end}}{{/*
move godoc to src/cmd/godoc R=rsc DELTA=945 (944 added, 0 deleted, 1 changed) OCL=30315 CL=30341
2009-06-16 10:14:06 -06:00
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
---------------------------------------
*/}}{{with .Funcs}}
move godoc to src/cmd/godoc R=rsc DELTA=945 (944 added, 0 deleted, 1 changed) OCL=30315 CL=30341
2009-06-16 10:14:06 -06:00
FUNCTIONS
tweak the newlines so the headers stand out better. old: CONSTANTS const ( MissingKind = iota; ) new: CONSTANTS const ( MissingKind = iota; ) R=gri,rsc DELTA=4 (4 added, 0 deleted, 0 changed) OCL=30362 CL=30598
2009-06-22 15:18:23 -06:00
godoc: fix lib/godoc/package.txt template - show documentation in text mode; e.g.: http://localhost:7777/cmd/godoc/?f=text - simplify template by using $ variable R=r, adg CC=golang-dev https://golang.org/cl/4873045
2011-08-15 16:42:27 -06:00
{{range .}}{{node .Decl $.FSet}}
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
{{.Doc}}
{{end}}{{end}}{{/*
move godoc to src/cmd/godoc R=rsc DELTA=945 (944 added, 0 deleted, 1 changed) OCL=30315 CL=30341
2009-06-16 10:14:06 -06:00
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
---------------------------------------
tweak the newlines so the headers stand out better. old: CONSTANTS const ( MissingKind = iota; ) new: CONSTANTS const ( MissingKind = iota; ) R=gri,rsc DELTA=4 (4 added, 0 deleted, 0 changed) OCL=30362 CL=30598
2009-06-22 15:18:23 -06:00
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
*/}}{{with .Types}}
TYPES
Show BUG comments in godoc: ast.go: - rename Comments -> CommentGroup (less confusion) - change all comments/docs to be *CommentGroup filter.go: - do not remove unassociated comments from program as part of export filtering (they are needed by doc.go for BUG comments) scanner.go: - exclude '\n' from //-style comments parser.go: - rewrote collection of comments: now all collected comments are *ast.CommentGroups - clarified distinction between leading and trailing comments - fixed a bug in comment collection (parseGenDecl); corresponding test case is in printer/testdata - extra documentation doc.go: - collect BUG comments - corresponding fix for parser bug in comment collection comment.go: - simplified regex printer.go: - adjust comment printing to new representation printer_test.go, testdata/*: - enable printing of doc comments - extended tests package.html, package.txt: - added Bugs section gofmt: - enable printing of doc comments R=rsc DELTA=339 (126 added, 38 deleted, 175 changed) OCL=31403 CL=31416
2009-07-09 17:38:17 -06:00
godoc: fix lib/godoc/package.txt template - show documentation in text mode; e.g.: http://localhost:7777/cmd/godoc/?f=text - simplify template by using $ variable R=r, adg CC=golang-dev https://golang.org/cl/4873045
2011-08-15 16:42:27 -06:00
{{range .}}{{node .Decl $.FSet}}
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
{{.Doc}}
godoc: fix lib/godoc/package.txt template - show documentation in text mode; e.g.: http://localhost:7777/cmd/godoc/?f=text - simplify template by using $ variable R=r, adg CC=golang-dev https://golang.org/cl/4873045
2011-08-15 16:42:27 -06:00
{{range .Consts}}{{node .Decl $.FSet}}
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
{{.Doc}}
godoc: fix lib/godoc/package.txt template - show documentation in text mode; e.g.: http://localhost:7777/cmd/godoc/?f=text - simplify template by using $ variable R=r, adg CC=golang-dev https://golang.org/cl/4873045
2011-08-15 16:42:27 -06:00
{{end}}{{range .Vars}}{{node .Decl $.FSet}}
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
{{.Doc}}
godoc: fix lib/godoc/package.txt template - show documentation in text mode; e.g.: http://localhost:7777/cmd/godoc/?f=text - simplify template by using $ variable R=r, adg CC=golang-dev https://golang.org/cl/4873045
2011-08-15 16:42:27 -06:00
{{end}}{{range .Factories}}{{node .Decl $.FSet}}
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
{{.Doc}}
godoc: fix lib/godoc/package.txt template - show documentation in text mode; e.g.: http://localhost:7777/cmd/godoc/?f=text - simplify template by using $ variable R=r, adg CC=golang-dev https://golang.org/cl/4873045
2011-08-15 16:42:27 -06:00
{{end}}{{range .Methods}}{{node .Decl $.FSet}}
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
{{.Doc}}
{{end}}{{end}}{{end}}{{/*
---------------------------------------
*/}}{{with .Bugs}}
Show BUG comments in godoc: ast.go: - rename Comments -> CommentGroup (less confusion) - change all comments/docs to be *CommentGroup filter.go: - do not remove unassociated comments from program as part of export filtering (they are needed by doc.go for BUG comments) scanner.go: - exclude '\n' from //-style comments parser.go: - rewrote collection of comments: now all collected comments are *ast.CommentGroups - clarified distinction between leading and trailing comments - fixed a bug in comment collection (parseGenDecl); corresponding test case is in printer/testdata - extra documentation doc.go: - collect BUG comments - corresponding fix for parser bug in comment collection comment.go: - simplified regex printer.go: - adjust comment printing to new representation printer_test.go, testdata/*: - enable printing of doc comments - extended tests package.html, package.txt: - added Bugs section gofmt: - enable printing of doc comments R=rsc DELTA=339 (126 added, 38 deleted, 175 changed) OCL=31403 CL=31416
2009-07-09 17:38:17 -06:00
BUGS
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
{{range .}}{{.}}
{{end}}{{end}}{{end}}{{/*
---------------------------------------
godoc: support for multiple packages in a directory - smartly select the "right" package - provide a list of other packages R=rsc CC=golang-dev https://golang.org/cl/466042
2010-03-12 19:16:21 -07:00
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
*/}}{{with .PList}}
godoc: support for multiple packages in a directory - smartly select the "right" package - provide a list of other packages R=rsc CC=golang-dev https://golang.org/cl/466042
2010-03-12 19:16:21 -07:00
OTHER PACKAGES
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
{{range .}}
{{.}}{{end}}
{{end}}{{/*
---------------------------------------
Factored out boilerplate from all html docs in doc directory: - the first HTML comment in those files is extracted as page title when serving them - lib/godoc.html is top-level template for all pages served - experimented a bit with package documentation layout (feedback welcome) - various related cleanups TODO: - The / page (doc/root.html) content repeats links that are in the navigation bar. It needs to be cleaned up. R=rsc DELTA=826 (86 added, 692 deleted, 48 changed) OCL=35230 CL=35245
2009-10-01 15:08:00 -06:00
godoc: moving to new template package - first step; rough conversion of all template files - there is plenty of opportunity for cleanups/simplifications (next CLs) - html and text output as before R=r, dsymonds CC=golang-dev https://golang.org/cl/4852048
2011-08-11 14:24:13 -06:00
*/}}{{with .Dirs}}
Factored out boilerplate from all html docs in doc directory: - the first HTML comment in those files is extracted as page title when serving them - lib/godoc.html is top-level template for all pages served - experimented a bit with package documentation layout (feedback welcome) - various related cleanups TODO: - The / page (doc/root.html) content repeats links that are in the navigation bar. It needs to be cleaned up. R=rsc DELTA=826 (86 added, 692 deleted, 48 changed) OCL=35230 CL=35245
2009-10-01 15:08:00 -06:00
SUBDIRECTORIES
godoc: provide mode for flat (non-indented) directory listings This feature should make it easier to look at very large directory trees. - a new mode (URL: /pkg/?m=flat) shows directory listings w/o indentation and entries with full path (html and text mode) - in text mode, hierarchical (non-flat) directory listings are now presented with indentation (/pkg/?m=text) - in html mode, hierarchical (non-flat) directory listings are presented with slightly less indentation - there is an internal hook for programmatic control of the display mode (for specialized versions of godoc). R=bradfitz CC=golang-dev, rsc https://golang.org/cl/5410043
2011-11-17 15:47:49 -07:00
{{if $.DirFlat}}{{range .List}}
{{.Path}}{{end}}
{{else}}{{range .List}}
{{repeat `. ` .Depth}}{{.Name}}{{end}}
{{end}}{{end}}
Copy Permalink