1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
// Copyright 2022 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package doc
import (
"bytes"
"go/parser"
"go/token"
"internal/diff"
"testing"
)
func TestComment(t *testing.T) {
fset := token.NewFileSet()
pkgs, err := parser.ParseDir(fset, "testdata/pkgdoc", nil, parser.ParseComments)
if err != nil {
t.Fatal(err)
}
if pkgs["pkgdoc"] == nil {
t.Fatal("missing package pkgdoc")
}
pkg := New(pkgs["pkgdoc"], "testdata/pkgdoc", 0)
var (
input = "[T] and [U] are types, and [T.M] is a method, but [V] is a broken link. [rand.Int] and [crand.Reader] are things. [G.M1] and [G.M2] are generic methods.\n"
wantHTML = `<p><a href="#T">T</a> and <a href="#U">U</a> are types, and <a href="#T.M">T.M</a> is a method, but [V] is a broken link. <a href="/math/rand#Int">rand.Int</a> and <a href="/crypto/rand#Reader">crand.Reader</a> are things. <a href="#G.M1">G.M1</a> and <a href="#G.M2">G.M2</a> are generic methods.` + "\n"
wantOldHTML = "<p>[T] and [U] are <i>types</i>, and [T.M] is a method, but [V] is a broken link. [rand.Int] and [crand.Reader] are things. [G.M1] and [G.M2] are generic methods.\n"
wantMarkdown = "[T](#T) and [U](#U) are types, and [T.M](#T.M) is a method, but \\[V] is a broken link. [rand.Int](/math/rand#Int) and [crand.Reader](/crypto/rand#Reader) are things. [G.M1](#G.M1) and [G.M2](#G.M2) are generic methods.\n"
wantText = "T and U are types, and T.M is a method, but [V] is a broken link. rand.Int and\ncrand.Reader are things. G.M1 and G.M2 are generic methods.\n"
wantOldText = "[T] and [U] are types, and [T.M] is a method, but [V] is a broken link.\n[rand.Int] and [crand.Reader] are things. [G.M1] and [G.M2] are generic methods.\n"
wantSynopsis = "T and U are types, and T.M is a method, but [V] is a broken link."
wantOldSynopsis = "[T] and [U] are types, and [T.M] is a method, but [V] is a broken link."
)
if b := pkg.HTML(input); string(b) != wantHTML {
t.Errorf("%s", diff.Diff("pkg.HTML", b, "want", []byte(wantHTML)))
}
if b := pkg.Markdown(input); string(b) != wantMarkdown {
t.Errorf("%s", diff.Diff("pkg.Markdown", b, "want", []byte(wantMarkdown)))
}
if b := pkg.Text(input); string(b) != wantText {
t.Errorf("%s", diff.Diff("pkg.Text", b, "want", []byte(wantText)))
}
if b := pkg.Synopsis(input); b != wantSynopsis {
t.Errorf("%s", diff.Diff("pkg.Synopsis", []byte(b), "want", []byte(wantText)))
}
var buf bytes.Buffer
buf.Reset()
ToHTML(&buf, input, map[string]string{"types": ""})
if b := buf.Bytes(); string(b) != wantOldHTML {
t.Errorf("%s", diff.Diff("ToHTML", b, "want", []byte(wantOldHTML)))
}
buf.Reset()
ToText(&buf, input, "", "\t", 80)
if b := buf.Bytes(); string(b) != wantOldText {
t.Errorf("%s", diff.Diff("ToText", b, "want", []byte(wantOldText)))
}
if b := Synopsis(input); b != wantOldSynopsis {
t.Errorf("%s", diff.Diff("Synopsis", []byte(b), "want", []byte(wantOldText)))
}
}
|
