kdoc

问题 For the two given methods: /** * Adds a [DataItem] to the Android Wear network. The updated item is synchronized across all devices. */ fun putItem(){ .... } /** * "same KDOC here with above" */ fun putItem(putRequest: PutDataRequest){ .... } Is there any possibility to copy/link the docs of the second method to be the same with the first one? Manually copy pasting the KDOC is not so great because if you update one of them there is high chance the second to accidentally be outdated. 回答1:

问题 Given the following code fun example() {} fun example(name: String) {} How can I reference a specific function? I.e. example() or example(String) ? Using [example] I can't specify which exactly function I want. 回答1: At this time you can't. Dokka generates all overloads of a function on a single page, and the link points to that page, so you can simply specify the overload you need as text: "the one-argument overload of [example]". There is an open issue for adding the possibility to link to a

问题 We develop a closed sources library in Kotlin that is released as AAR. Unfortunatly our users can't see the KDoc (JavaDoc for Kotlin) in the IDE. Therefore we want to release the source of the public API only. The internals and the public API can be distingushed by there packages foo.bar.api.* and foo.bar.internal.* Is this possible with gradle 3.4? I found Create Android library AAR including javadoc and sources but we don't want to include all sources. 回答1: Let's assume you know already how

问题 We develop a closed sources library in Kotlin that is released as AAR. Unfortunatly our users can't see the KDoc (JavaDoc for Kotlin) in the IDE. Therefore we want to release the source of the public API only. The internals and the public API can be distingushed by there packages foo.bar.api.* and foo.bar.internal.* Is this possible with gradle 3.4? I found Create Android library AAR including javadoc and sources but we don't want to include all sources. 回答1: Let's assume you know already how

问题 We develop a closed sources library in Kotlin that is released as AAR. Unfortunatly our users can't see the KDoc (JavaDoc for Kotlin) in the IDE. Therefore we want to release the source of the public API only. The internals and the public API can be distingushed by there packages foo.bar.api.* and foo.bar.internal.* Is this possible with gradle 3.4? I found Create Android library AAR including javadoc and sources but we don't want to include all sources. 回答1: Let's assume you know already how

问题 We develop a closed sources library in Kotlin that is released as AAR. Unfortunatly our users can't see the KDoc (JavaDoc for Kotlin) in the IDE. Therefore we want to release the source of the public API only. The internals and the public API can be distingushed by there packages foo.bar.api.* and foo.bar.internal.* Is this possible with gradle 3.4? I found Create Android library AAR including javadoc and sources but we don't want to include all sources. 回答1: Let's assume you know already how

问题 I am currently testing the Dokka documentation and some of the annotations I have made are not being rendered. Here are my findings: Classes don't show @sample , and html tags <p></p> , <h1></h1> : See SimpleCalculator class documentation If a description was under an html tag, it will not show: See enum class OPERATOR code documentation Methods don't show @sample and @property at all: See all the method code documentation Mixed of definition between @property and @param . In class

问题 I am currently testing the Dokka documentation and some of the annotations I have made are not being rendered. Here are my findings: Classes don't show @sample , and html tags <p></p> , <h1></h1> : See SimpleCalculator class documentation If a description was under an html tag, it will not show: See enum class OPERATOR code documentation Methods don't show @sample and @property at all: See all the method code documentation Mixed of definition between @property and @param . In class

问题 I am currently testing the Dokka documentation and some of the annotations I have made are not being rendered. Here are my findings: Classes don't show @sample , and html tags <p></p> , <h1></h1> : See SimpleCalculator class documentation If a description was under an html tag, it will not show: See enum class OPERATOR code documentation Methods don't show @sample and @property at all: See all the method code documentation Mixed of definition between @property and @param . In class

问题 Consider the class comment of this Kotlin class: /** * This class has two methods, one that takes one parameters ([foo]), * and another one that takes two parameters ([foo]). **/ class Clazz { /* Foo with one. */ fun foo(a: Int) { } /* Foo with two. */ fun foo(a: Int, b: Int) { } } I'd like the second link to point to the 2nd function ( the one with the two parameters ). Is this possible in the Kotlin documentation language? 回答1: Just found this answer: Note that KDoc does not have any syntax