Skip to content

Commit 58f9fd3

Browse files
zolotovzolotov
committed
QuickDoc: add test of navigation info
1 parent a9b0bf2 commit 58f9fd3

16 files changed

+34
-2
lines changed

‎testData/doc/escape.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
<p>If n &lt; 0, there is no limit on the number of replacements.
33
</p>
44

5+
=====
6+
func Replace(s <a href="psi_element://builtin#string">string</a>, old <a href="psi_element://builtin#string">string</a>, new <a href="psi_element://builtin#string">string</a>, n <a href="psi_element://builtin#int">int</a>) <a href="psi_element://builtin#string">string</a>
57
=====
68
https://godoc.org/null#Replace

‎testData/doc/escapeReturnValues.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
<p>If n &lt; 0, there is no limit on the number of replacements.
33
</p>
44

5+
=====
6+
func Replace(s <a href="psi_element://builtin#string">string</a>, old <a href="psi_element://builtin#string">string</a>, new <a href="psi_element://builtin#string">string</a>, n <a href="psi_element://builtin#int">int</a>) &lt;-chan <a href="psi_element://builtin#string">string</a>
57
=====
68
https://godoc.org/null#Replace

‎testData/doc/fprintln.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,7 @@ Spaces are always added between operands and a newline is appended.
44
It returns the number of bytes written and any write error encountered.
55
</p>
66

7+
=====
8+
func Fprintln(w io.Writer, a ...interface{}) (n <a href="psi_element://builtin#int">int</a>, err <a href="psi_element://builtin#error">error</a>)
79
=====
810
https://godoc.org/fmt#Fprintln

‎testData/doc/method.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
<p>Name returns the name of the file as presented to Open.
33
</p>
44

5+
=====
6+
func Name() <a href="psi_element://builtin#string">string</a>
57
=====
68
https://godoc.org/os#File.Name

‎testData/doc/multilineTypeListDefinition.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
<p>MultiType is a function like all other functions
33
</p>
44

5+
=====
6+
func MultiType(demo interface{}, err <a href="psi_element://builtin#error">error</a>) ([]interface{}, <a href="psi_element://builtin#error">error</a>)
57
=====
68
https://godoc.org/docs#MultiType

‎testData/doc/package.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,7 @@ various implementations, unless otherwise informed clients should not
1010
assume they are safe for parallel execution.
1111
</p>
1212

13+
=====
14+
No navigation info
1315
=====
1416
https://godoc.org/io

‎testData/doc/packageOnImportAlias.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,7 @@ various implementations, unless otherwise informed clients should not
1010
assume they are safe for parallel execution.
1111
</p>
1212

13+
=====
14+
No navigation info
1315
=====
1416
https://godoc.org/io

‎testData/doc/packageOnQualifier.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,7 @@ various implementations, unless otherwise informed clients should not
1010
assume they are safe for parallel execution.
1111
</p>
1212

13+
=====
14+
No navigation info
1315
=====
1416
https://godoc.org/io

‎testData/doc/packageWithDoc.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,7 @@ to C's printf and scanf. The format 'verbs' are derived from C's but
55
are simpler.
66
</p>
77

8+
=====
9+
No navigation info
810
=====
911
https://godoc.org/fmt

‎testData/doc/println.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,7 @@ Spaces are always added between operands and a newline is appended.
44
It returns the number of bytes written and any write error encountered.
55
</p>
66

7+
=====
8+
func Println(a ...interface{}) (n <a href="psi_element://builtin#int">int</a>, err <a href="psi_element://builtin#error">error</a>)
79
=====
810
https://godoc.org/fmt#Println

‎testData/doc/signature.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
<p>If n &lt; 0, there is no limit on the number of replacements.
33
</p>
44

5+
=====
6+
func Foo(a map[<a href="psi_element://builtin#int">int</a>]*<a href="psi_element://builtin#string">string</a>, b (<a href="psi_element://builtin#string">string</a>), c <a href="psi_element://builtin#string">string</a>, <a href="psi_element://builtin#int">int</a>) (&lt;-chan <a href="psi_element://builtin#string">string</a>, <a href="psi_element://builtin#int">int</a>)
57
=====
68
https://godoc.org/null#Foo

‎testData/doc/typeResultDefinition.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
<p>TypeResult func comment
33
</p>
44

5+
=====
6+
func TypeResult(s <a href="psi_element://builtin#string">string</a>) <a href="psi_element://builtin#string">string</a>
57
=====
68
https://godoc.org/docs#TypeResult

‎testData/doc/typeSpec.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
<p>my comment
33
</p>
44

5+
=====
6+
type MyType
57
=====
68
https://godoc.org/null#MyType

‎testData/doc/typeTopDefinition.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
<p>my inner comment
33
</p>
44

5+
=====
6+
type MyType1
57
=====
68
https://godoc.org/null#MyType1

‎testData/doc/variable.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<p>test
22
</p>
33

4+
=====
5+
No navigation info
46
=====
57
No urls

‎tests/com/goide/GoDocumentationProviderTest.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,8 @@ protected LightProjectDescriptor getProjectDescriptor() {
4848
public void testMultilineTypeListDefinition() { doTest(); }
4949
public void testSignature() { doTest(); }
5050
public void testTypeSpec() { doTest(); }
51-
public void testTypeTopDefinition() { doTest(); }
51+
public void testTypeTopDefinition() { doTest(); }
5252

53-
5453
public void testMultiBlockDoc() { doConverterTest(); }
5554
public void testIndentedBlock() { doConverterTest(); }
5655
public void testCommentEndsWithIndentedBlock() { doConverterTest(); }
@@ -84,6 +83,9 @@ private void doTest() {
8483
DocumentationProvider documentationProvider = DocumentationManager.getProviderFromElement(originalElement);
8584
String actualDoc = StringUtil.notNullize(documentationProvider.generateDoc(docElement, originalElement));
8685

86+
String quickNavigateInfo = documentationProvider.getQuickNavigateInfo(docElement, originalElement);
87+
actualDoc += "\n=====\n" + StringUtil.notNullize(quickNavigateInfo, "No navigation info");
88+
8789
List<String> urls = documentationProvider.getUrlFor(docElement, originalElement);
8890
actualDoc += "\n=====\n" + (urls != null ? StringUtil.join(urls, "\n") : "No urls");
8991
assertSameLinesWithFile(getTestDataPath() + "/" + getTestName(true) + ".txt", actualDoc);

0 commit comments

Comments
 (0)