]> Cypherpunks repositories - gostls13.git/commit
go/doc, godoc: improved note reading
authorRobert Griesemer <gri@golang.org>
Tue, 19 Mar 2013 18:14:35 +0000 (11:14 -0700)
committerRobert Griesemer <gri@golang.org>
Tue, 19 Mar 2013 18:14:35 +0000 (11:14 -0700)
commit5268119f26728ddd2ee9f8eebcbfcec83ac5bd69
tree373b761d351a9dd90d6ca5072fbaa130f089f375
parenta88d82813dfa3f56a6df2ecd25eaba480ef7e58e
go/doc, godoc: improved note reading

- 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
lib/godoc/package.html
lib/godoc/package.txt
src/cmd/godoc/godoc.go
src/pkg/go/doc/doc.go
src/pkg/go/doc/reader.go
src/pkg/go/doc/testdata/a.0.golden
src/pkg/go/doc/testdata/a.1.golden
src/pkg/go/doc/testdata/a.2.golden
src/pkg/go/doc/testdata/a0.go
src/pkg/go/doc/testdata/template.txt