QuickDoc: add test of navigation info

zolotov · zolotov · commit 58f9fd3045b9 · 2015-11-25T13:44:24.000+03:00
diff --git a/testData/doc/escape.txt b/testData/doc/escape.txt
@@ -2,5 +2,7 @@
 <p>If n &lt; 0, there is no limit on the number of replacements.
 </p>
 
+=====
+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>
 =====
 https://godoc.org/null#Replace
diff --git a/testData/doc/escapeReturnValues.txt b/testData/doc/escapeReturnValues.txt
@@ -2,5 +2,7 @@
 <p>If n &lt; 0, there is no limit on the number of replacements.
 </p>
 
+=====
+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>
 =====
 https://godoc.org/null#Replace
diff --git a/testData/doc/fprintln.txt b/testData/doc/fprintln.txt
@@ -4,5 +4,7 @@ Spaces are always added between operands and a newline is appended.
 It returns the number of bytes written and any write error encountered.
 </p>
 
+=====
+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>)
 =====
 https://godoc.org/fmt#Fprintln
diff --git a/testData/doc/method.txt b/testData/doc/method.txt
@@ -2,5 +2,7 @@
 <p>Name returns the name of the file as presented to Open.
 </p>
 
+=====
+func Name() <a href="psi_element://builtin#string">string</a>
 =====
 https://godoc.org/os#File.Name
diff --git a/testData/doc/multilineTypeListDefinition.txt b/testData/doc/multilineTypeListDefinition.txt
@@ -2,5 +2,7 @@
 <p>MultiType is a function like all other functions
 </p>
 
+=====
+func MultiType(demo interface{}, err <a href="psi_element://builtin#error">error</a>) ([]interface{}, <a href="psi_element://builtin#error">error</a>)
 =====
 https://godoc.org/docs#MultiType
diff --git a/testData/doc/package.txt b/testData/doc/package.txt
@@ -10,5 +10,7 @@ various implementations, unless otherwise informed clients should not
 assume they are safe for parallel execution.
 </p>
 
+=====
+No navigation info
 =====
 https://godoc.org/io
diff --git a/testData/doc/packageOnImportAlias.txt b/testData/doc/packageOnImportAlias.txt
@@ -10,5 +10,7 @@ various implementations, unless otherwise informed clients should not
 assume they are safe for parallel execution.
 </p>
 
+=====
+No navigation info
 =====
 https://godoc.org/io
diff --git a/testData/doc/packageOnQualifier.txt b/testData/doc/packageOnQualifier.txt
@@ -10,5 +10,7 @@ various implementations, unless otherwise informed clients should not
 assume they are safe for parallel execution.
 </p>
 
+=====
+No navigation info
 =====
 https://godoc.org/io
diff --git a/testData/doc/packageWithDoc.txt b/testData/doc/packageWithDoc.txt
@@ -5,5 +5,7 @@ to C's printf and scanf.  The format 'verbs' are derived from C's but
 are simpler.
 </p>
 
+=====
+No navigation info
 =====
 https://godoc.org/fmt
diff --git a/testData/doc/println.txt b/testData/doc/println.txt
@@ -4,5 +4,7 @@ Spaces are always added between operands and a newline is appended.
 It returns the number of bytes written and any write error encountered.
 </p>
 
+=====
+func Println(a ...interface{}) (n <a href="psi_element://builtin#int">int</a>, err <a href="psi_element://builtin#error">error</a>)
 =====
 https://godoc.org/fmt#Println
diff --git a/testData/doc/signature.txt b/testData/doc/signature.txt
@@ -2,5 +2,7 @@
 <p>If n &lt; 0, there is no limit on the number of replacements.
 </p>
 
+=====
+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>)
 =====
 https://godoc.org/null#Foo
diff --git a/testData/doc/typeResultDefinition.txt b/testData/doc/typeResultDefinition.txt
@@ -2,5 +2,7 @@
 <p>TypeResult func comment
 </p>
 
+=====
+func TypeResult(s <a href="psi_element://builtin#string">string</a>) <a href="psi_element://builtin#string">string</a>
 =====
 https://godoc.org/docs#TypeResult
diff --git a/testData/doc/typeSpec.txt b/testData/doc/typeSpec.txt
@@ -2,5 +2,7 @@
 <p>my comment
 </p>
 
+=====
+type MyType
 =====
 https://godoc.org/null#MyType
diff --git a/testData/doc/typeTopDefinition.txt b/testData/doc/typeTopDefinition.txt
@@ -2,5 +2,7 @@
 <p>my inner comment
 </p>
 
+=====
+type MyType1
 =====
 https://godoc.org/null#MyType1
diff --git a/testData/doc/variable.txt b/testData/doc/variable.txt
@@ -1,5 +1,7 @@
 <p>test
 </p>
 
+=====
+No navigation info
 =====
 No urls
diff --git a/tests/com/goide/GoDocumentationProviderTest.java b/tests/com/goide/GoDocumentationProviderTest.java
@@ -48,9 +48,8 @@ protected LightProjectDescriptor getProjectDescriptor() {
   public void testMultilineTypeListDefinition()   { doTest(); }
   public void testSignature()                     { doTest(); }
   public void testTypeSpec()                      { doTest(); }
-  public void testTypeTopDefinition()                 { doTest(); }
+  public void testTypeTopDefinition()             { doTest(); }
   
-
   public void testMultiBlockDoc()                 { doConverterTest(); }
   public void testIndentedBlock()                 { doConverterTest(); }
   public void testCommentEndsWithIndentedBlock()  { doConverterTest(); }
@@ -84,6 +83,9 @@ private void doTest() {
     DocumentationProvider documentationProvider = DocumentationManager.getProviderFromElement(originalElement);
     String actualDoc = StringUtil.notNullize(documentationProvider.generateDoc(docElement, originalElement));
     
+    String quickNavigateInfo = documentationProvider.getQuickNavigateInfo(docElement, originalElement);
+    actualDoc += "\n=====\n" + StringUtil.notNullize(quickNavigateInfo, "No navigation info");
+    
     List<String> urls = documentationProvider.getUrlFor(docElement, originalElement);
     actualDoc += "\n=====\n" + (urls != null ? StringUtil.join(urls, "\n") : "No urls");
     assertSameLinesWithFile(getTestDataPath() + "/" + getTestName(true) + ".txt", actualDoc);
