cmd/godoc: add support for doc.Package.Notes

Add support for displaying the notes of the form 'MARKER(userid): comment' now collected by the go/doc package. Any two or more uppercase letters are recognised as a marker.

R=gri, rsc, bradfitz
CC=golang-dev
https://golang.org/cl/7334044

diff --git a/lib/godoc/package.html b/lib/godoc/package.html
index e67cf93bed381baae2f40c57d83c1186577af0cf..cff91fa22645cd66646f82ddf3c58fb03757371f 100644 (file)
--- a/lib/godoc/package.html
+++ b/lib/godoc/package.html
@@ -73,6 +73,11 @@
                        {{if .Bugs}}
                                <dd><a href="#pkg-bugs">Bugs</a></dd>
                        {{end}}
+                       {{if .Notes}}
+                                {{range $marker, $item := .Notes}}
+                               <dd><a href="#pkg-{{$marker}}">{{$marker}}</a></dd>
+                                {{end}}
+                       {{end}}
                        </dl>
                        </div><!-- #manual-nav -->
 
@@ -168,6 +173,14 @@
                {{comment_html .}}
                {{end}}
        {{end}}
+       {{with .Notes}}
+                {{range $marker, $content := .}}
+                   <h2 id="pkg-{{$marker}}">{{$marker}}</h2>
+                   {{range .}}
+                   {{comment_html .}}
+                    {{end}}
+               {{end}}
+       {{end}}
 {{end}}
 
 {{with .PAst}}

diff --git a/lib/godoc/package.txt b/lib/godoc/package.txt
index 8b9ec456bfb3eb10f6a55c64beb05197bab32160..12964b0010d5ef95d2e091b963d6130543f543b7 100644 (file)
--- a/lib/godoc/package.txt
+++ b/lib/godoc/package.txt
@@ -61,7 +61,12 @@ TYPES
 BUGS
 
 {{range .}}{{comment_text . "    " "\t"}}
-{{end}}{{end}}{{end}}{{/*
+{{end}}{{end}}{{with .Notes}}
+{{range $marker, $content := .}}
+{{$marker}}
+
+{{range $content}}{{comment_text . "    " "\t"}}
+{{end}}{{end}}{{end}}{{end}}{{/*
 
 ---------------------------------------