diff options
Diffstat (limited to 'src/pkg/go/doc/comment.go')
| -rw-r--r-- | src/pkg/go/doc/comment.go | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/src/pkg/go/doc/comment.go b/src/pkg/go/doc/comment.go index c4b7e6ae6..5c8c43e0c 100644 --- a/src/pkg/go/doc/comment.go +++ b/src/pkg/go/doc/comment.go @@ -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 |