1
0
mirror of https://github.com/golang/go synced 2024-11-23 00:10:07 -07:00

go/doc: update ToHTML doc comment

Update #5429

R=golang-dev, r, dan.kortschak
CC=golang-dev
https://golang.org/cl/14293043
This commit is contained in:
Russ Cox 2013-10-03 09:49:12 -04:00
parent 408238e20b
commit 01479b6c4a

View File

@ -239,9 +239,14 @@ func anchorID(line string) string {
// nor to have trailing spaces at the end of lines.
// The comment markers have already been removed.
//
// Turn each run of multiple \n into </p><p>.
// Turn each run of indented lines into a <pre> block without indent.
// Enclose headings with header tags.
// Each span of unindented non-blank lines is converted into
// a single paragraph. There is one exception to the rule: a span that
// consists of a single line, is followed by another paragraph span,
// begins with a capital letter, and contains no punctuation
// is formatted as a heading.
//
// A span of indented lines is converted into a <pre> block,
// with the common indent prefix removed.
//
// URLs in the comment text are converted into links; if the URL also appears
// in the words map, the link is taken from the map (if the corresponding map