Merge pull request #552 from JetBrains/rr/yole/kdoc-generate

structured rendering of doc comments in quick documentation dialog

idea/testData/editor/quickDoc/OnFunctionDeclarationWithPackage.kt

@@ -7,9 +7,9 @@ package test
  * Test function
 
  *
- * @param first - Some
- * @param second - Other
+ * @param first Some
+ * @param second Other
  */
 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/><b>@param</b> - <i>first</i> - Some<br/><b>@param</b> - <i>second</i> - Other<br/></p>
+// 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>

idea/testData/editor/quickDoc/OnMethodUsage.kt

@@ -1,8 +1,8 @@
 /**
  Some documentation
 
- @param a - Some int
- * @param b: String
+ * @param a Some int
+ * @param b String
  */
 fun testMethod(a: Int, b: String) {
 
@@ -12,4 +12,4 @@ 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/><b>@param</b> - <i>a</i> - Some int<br/><b>@param</b> - <i>b</i>: String<br/></p>
+// 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>

idea/testData/editor/quickDoc/OnMethodUsageWithBracketsInParam.kt

@@ -0,0 +1,15 @@
+/**
+ Some documentation
+
+ * @param[a] Some int
+ * @param[b] String
+ */
+fun testMethod(a: Int, b: String) {
+
+}
+
+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>

idea/testData/editor/quickDoc/OnMethodUsageWithReturnAndThrows.kt

@@ -0,0 +1,17 @@
+/**
+Some documentation
+
+ * @param a Some int
+ * @param b String
+ * @return Return value
+ * @throws IllegalArgumentException if the weather is bad
+ */
+fun testMethod(a: Int, b: String) {
+
+}
+
+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> value</dd></dl><dl><dt><b>Throws:</b></dt><dd><code>IllegalArgumentException</code> - if the weather is bad</dd></dl></p>