azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

structured rendering of doc comments in quick documentation dialog

Browse Source
This commit is contained in:
Dmitry Jemerov
2015-01-21 16:20:20 +01:00
parent 6c814279fc
commit 659c54d7e6
11 changed files with 222 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files
idea/testData/editor/quickDoc/OnFunctionDeclarationWithPackage.kt
+3 -3
View File
@@ -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
+3 -3
View File
@@ -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/OnMethodUsageWithReturnAndThrows.kt
+17
View File
@@ -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>