Files
kotlin/idea/testData/codeInsight/renderingKDoc/difficultKDoc.kt
2020-04-03 12:38:51 +03:00

57 lines
3.6 KiB
Kotlin
Vendored

/**
*
* This class has no useful logic; it's just a documentation example.
*
* @param T the type of a member in this class.
* @param X the type of a member in this class.
* @property name is blablabla for name
* @property name2 is blublublu for name2
* @constructor primary ctor for it
*/
class klass<T, X>(val name: String, val name2: String) {
/**
* This method has no useful logic; it's just a documentation example.
*
* @param M the type of a member in this method.
* @param K the type of a member in this group.
* @property[name] is blablabla for name
* @property name2 blublublu for name2
* @throws IndexOutOfBoundsException if something wrong
* @throws ArrayIndexOutOfBoundsException if else something wrong
* @exception java.io.IOException if something else else wrong
* @see method2
* @see method3
* @return [returnMethod] if Duck is Dark
* @author DarkWing Duck
* @suppress something to suppress
* @sample sample
* @sample sample2
*/
fun <M, K> method(name: String, name2: String) {
}
fun method2() {
}
fun method3() {
}
fun returnMethod() {
}
fun sample() {
//this is the sample
}
fun sample2() {
//this is the sample2
}
}
//RENDER: <div class='content'><p>This class has no useful logic; it's just a documentation example.</p></div><table class='sections'><tr><td valign='top' class='section'><p>Params:</td><td valign='top'><p><code>T</code> - the type of a member in this class.<p><code>X</code> - the type of a member in this class.</td><tr><td valign='top' class='section'><p>Properties:</td><td valign='top'><p><code>name</code> - is blablabla for name<p><code>name2</code> - is blublublu for name2</td><tr><td valign='top' class='section'><p>Constructor:</td><td valign='top'>primary ctor for it</td></table>
//RENDER: <div class='content'><p>This method has no useful logic; it's just a documentation example.</p></div><table class='sections'><tr><td valign='top' class='section'><p>Params:</td><td valign='top'><p><code>M</code> - the type of a member in this method.<p><code>K</code> - the type of a member in this group.</td><tr><td valign='top' class='section'><p>Properties:</td><td valign='top'><p><code>name</code> - is blablabla for name<p><code>name2</code> - blublublu for name2</td><tr><td valign='top' class='section'><p>Returns:</td><td valign='top'><a href="psi_element://returnMethod">returnMethod</a> if Duck is Dark</td><tr><td valign='top' class='section'><p>Throws:</td><td valign='top'><p><code><a href="psi_element://IndexOutOfBoundsException"><code>IndexOutOfBoundsException</code></a></code> - if something wrong<p><code><a href="psi_element://ArrayIndexOutOfBoundsException"><code>ArrayIndexOutOfBoundsException</code></a></code> - if else something wrong<p><code><a href="psi_element://java.io.IOException"><code>java.io.IOException</code></a></code> - if something else else wrong</td><tr><td valign='top' class='section'><p>Author:</td><td valign='top'>DarkWing Duck</td><tr><td valign='top' class='section'><p>Suppress:</td><td valign='top'>something to suppress</td><tr><td valign='top' class='section'><p>See Also:</td><td valign='top'><a href="psi_element://method2"><code>method2</code></a>, <a href="psi_element://method3"><code>method3</code></a></td><tr><td valign='top' class='section'><p>Samples:</td><td valign='top'><p><a href="psi_element://sample"><code>sample</code></a><pre><code>//this is the sample</code></pre><p><a href="psi_element://sample2"><code>sample2</code></a><pre><code>//this is the sample2</code></pre></td></table>