qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-21 18:04:40 -07:00
Code Releases Activity

godoc: collect package comments from all package files, not just the first one found

Browse Source 
R=r
CC=golang-dev
https://golang.org/cl/1331041
This commit is contained in:
Robert Griesemer 2010-05-26 13:44:27 -07:00
parent f199f292e7
commit a4129988a4
1 changed files with 23 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/pkg/go/doc/doc.go
View File

@ -53,6 +53,28 @@ func (doc *docReader) init(pkgName string) {
}
func (doc *docReader) addDoc(comments *ast.CommentGroup) {
if doc.doc == nil {
// common case: just one package comment
doc.doc = comments
return
}
// More than one package comment: Usually there will be only
// one file with a package comment, but it's better to collect
// all comments than drop them on the floor.
// (This code isn't particularly clever - no amortized doubling is
// used - but this situation occurs rarely and is not time-critical.)
n1 := len(doc.doc.List)
n2 := len(comments.List)
list := make([]*ast.Comment, n1+1+n2) // + 1 for separator line
copy(list, doc.doc.List)
list[n1] = &ast.Comment{token.Position{}, []byte("//")} // separator line
copy(list[n1+1:], comments.List)
doc.doc = &ast.CommentGroup{list}
}
func (doc *docReader) addType(decl *ast.GenDecl) {
spec := decl.Specs[0].(*ast.TypeSpec)
typ := doc.lookupTypeDoc(spec.Name.Name())
@ -275,12 +297,7 @@ var (
func (doc *docReader) addFile(src *ast.File) {
// add package documentation
if src.Doc != nil {
// TODO(gri) This won't do the right thing if there is more
// than one file with package comments. Consider
// using ast.MergePackageFiles which handles these
// comments correctly (but currently looses BUG(...)
// comments).
doc.doc = src.Doc
doc.addDoc(src.Doc)
src.Doc = nil // doc consumed - remove from ast.File node
}