render Markdown and support link navigation in KDoc comments

2015-03-10 16:30:13 +01:00
parent 99fb75c943
commit 853fce4b71
23 changed files with 387 additions and 47 deletions
@@ -2,4 +2,4 @@ fun ktTest() {
    Test.<caret>foo("SomeTest")
 }

-// INFO: <b>public</b> <b>open</b> <b>fun</b> foo(param: String!): Array&lt;(out) Any!&gt;!<br/>Java declaration:<br/>Test...
+//INFO: <b>public</b> <b>open</b> <b>fun</b> foo(param: String!): Array&lt;(out) Any!&gt;!<br/>Java declaration:<br/>Test...
@@ -6,4 +6,4 @@ class KotlinClassUsedFromJava {
    }
 }

-// INFO: [light_idea_test_case] testing...
+//INFO: [light_idea_test_case] testing.TestingPackage...
@@ -2,4 +2,5 @@ fun test() {
    listOf(1, 2, 4).<caret>filter { it > 0 }
 }

-// INFO: inline <b>public</b> <b>fun</b> &lt;T&gt; Iterable&lt;T&gt;.filter(predicate: (T) &rarr; Boolean): List&lt;T&gt;<br/><p>Returns a list containing all elements matching the given [predicate]</p>
+//INFO: inline <b>public</b> <b>fun</b> &lt;T&gt; Iterable&lt;T&gt;.filter(predicate: (T) &rarr; Boolean): List&lt;T&gt;<br/><p>Returns a list containing all elements matching the given <a href="psi_element://predicate">predicate</a>
+//INFO: </p>
@@ -3,4 +3,5 @@
 */
 class <caret>Some

-// INFO: <b>internal</b> <b>final</b> <b>class</b> Some<br/><p>Usefull comment</p>
+//INFO: <b>internal</b> <b>final</b> <b>class</b> Some<br/><p>Usefull comment
+//INFO: </p>
@@ -12,4 +12,6 @@ package test
 */
 fun <caret>testFun(first: String, second: Int) = 12

-// INFO: <b>internal</b> <b>fun</b> testFun(first: String, second: Int): Int<br/><p>Test function<br/><br/><br/><dl><dt><b>Parameters:</b></dt><dd><code>first</code> - Some</dd><dd><code>second</code> - Other</dd></dl></p>
+//INFO: <b>internal</b> <b>fun</b> testFun(first: String, second: Int): Int<br/><p>Test function
+//INFO: <dl><dt><b>Parameters:</b></dt><dd><code>first</code> - Some</dd><dd><code>second</code> - Other</dd></dl>
+//INFO: </p>
@@ -14,4 +14,5 @@ fun test() {
    D().f<caret>oo()
 }

-// INFO: <b>internal</b> <b>open</b> <b>fun</b> foo(): Int<br/><p>This method returns zero.</p>
+//INFO: <b>internal</b> <b>open</b> <b>fun</b> foo(): Int<br/><p>This method returns zero.
+//INFO: </p>
@@ -14,4 +14,5 @@ fun test() {
    D().f<caret>oo
 }

-// INFO: <b>internal</b> <b>open</b> <b>val</b> foo: Int<br/><p>This property returns zero.</p>
+//INFO: <b>internal</b> <b>open</b> <b>val</b> foo: Int<br/><p>This property returns zero.
+//INFO: </p>
@@ -1,5 +1,5 @@
 /**
- Some documentation
+Some documentation

 * @param a Some int
 * @param b String
@@ -12,4 +12,6 @@ fun test() {
    <caret>testMethod(1, "value")
 }

-// INFO: <b>internal</b> <b>fun</b> testMethod(a: Int, b: String): Unit<br/><p>Some documentation<br/><br/><dl><dt><b>Parameters:</b></dt><dd><code>a</code> - Some int</dd><dd><code>b</code> - String</dd></dl></p>
+//INFO: <b>internal</b> <b>fun</b> testMethod(a: Int, b: String): Unit<br/><p>Some documentation
+//INFO: <dl><dt><b>Parameters:</b></dt><dd><code>a</code> - Some int</dd><dd><code>b</code> - String</dd></dl>
+//INFO: </p>
@@ -1,5 +1,5 @@
 /**
- Some documentation
+Some documentation

 * @param[a] Some int
 * @param[b] String
@@ -12,4 +12,6 @@ fun test() {
    <caret>testMethod(1, "value")
 }

-// INFO: <b>internal</b> <b>fun</b> testMethod(a: Int, b: String): Unit<br/><p>Some documentation<br/><br/><dl><dt><b>Parameters:</b></dt><dd><code>a</code> - Some int</dd><dd><code>b</code> - String</dd></dl></p>
+//INFO: <b>internal</b> <b>fun</b> testMethod(a: Int, b: String): Unit<br/><p>Some documentation
+//INFO: <dl><dt><b>Parameters:</b></dt><dd><code>a</code> - Some int</dd><dd><code>b</code> - String</dd></dl>
+//INFO: </p>
@@ -0,0 +1,26 @@
+/**
+ * Some documentation. **Bold** *underline* `code` foo: bar (baz) [quux] <xyzzy>
+ *
+ * [Kotlin](http://www.kotlinlang.org)
+ *
+ * [C]
+ *
+ * [See this class][C]
+ */
+fun testMethod() {
+
+}
+
+class C {
+}
+
+fun test() {
+    <caret>testMethod(1, "value")
+}
+
+//INFO: <b>internal</b> <b>fun</b> testMethod(): Unit<br/><p><p>Some documentation. <strong>Bold</strong> <em>underline</em> <code>code</code> foo: bar (baz) <a href="psi_element://quux">quux</a> </p>
+//INFO: <p>a href="http://www.kotlinlang.org">Kotlin</a></p>
+//INFO: <p><a href="psi_element://C">C</a></p>
+//INFO: <p><a href="psi_element://C">See this class</a></p>
+//INFO:
+//INFO: </p>
@@ -14,4 +14,8 @@ fun test() {
    <caret>testMethod(1, "value")
 }

-// INFO: <b>internal</b> <b>fun</b> testMethod(a: Int, b: String): Unit<br/><p>Some documentation<br/><br/><dl><dt><b>Parameters:</b></dt><dd><code>a</code> - Some int</dd><dd><code>b</code> - String</dd></dl><dl><dt><b>Returns:</b></dt><dd>Return value</dd></dl><dl><dt><b>Throws:</b></dt><dd><code>IllegalArgumentException</code> - if the weather is bad</dd></dl></p>
+//INFO: <b>internal</b> <b>fun</b> testMethod(a: Int, b: String): Unit<br/><p>Some documentation
+//INFO: <dl><dt><b>Parameters:</b></dt><dd><code>a</code> - Some int</dd><dd><code>b</code> - String</dd></dl>
+//INFO: <dl><dt><b>Returns:</b></dt><dd>Return value</dd></dl>
+//INFO: <dl><dt><b>Throws:</b></dt><dd><code>IllegalArgumentException</code> - if the weather is bad</dd></dl>
+//INFO: </p>
@@ -0,0 +1,20 @@
+/**
+ * @see C
+ * @see D
+ */
+fun testMethod() {
+
+}
+
+class C {
+}
+
+class D {
+}
+
+fun test() {
+    <caret>testMethod(1, "value")
+}
+
+//INFO: <b>internal</b> <b>fun</b> testMethod(): Unit<br/><p>
+//INFO: <DD><DL><DT><b>See Also:</b><DD><a href="psi_element://C"><code>C</code></a>, <a href="psi_element://D"><code>D</code></a></DD></DL></DD></p>
@@ -8,4 +8,5 @@ class Testing {
    }
 }

-// INFO: <b>internal</b> <b>fun</b> foo(bar: Int): Unit<br/><p>KDoc foo</p>
+//INFO: <b>internal</b> <b>fun</b> foo(bar: Int): Unit<br/><p>KDoc foo
+//INFO: </p>