This is my javadoc
/**
* If you wish to add this fragment to your activity, you must implement {@link com.example.app.BlaActivity BlaActivity}
*
* @return an instance of BlaFragment
*/
BlaActivity
is a Kotlin class. When I hover over the method with the javadoc above, the popup says:
If you wish to add this fragment to your activity, you must implement
Returns:
an instance of BlaFragment
So, it does not show my Kotlin class in the popup. However it works fine when I use a Java class.
Javadoc has no support for Kotlin classes?
Just like Kotlin, Dokka fully supports cross-language Java/Kotlin projects. It can read Javadoc comments in Java code and KDoc comments in Kotlin code and generate documentation covering the entire API of a module, regardless of the language used to write each class in it.
For inline markup, KDoc uses the regular Markdown syntax, extended to support a shorthand syntax for linking to other elements in the code. To link to another element (class, method, property or parameter), simply put its name in square brackets: Use the method [foo] for this purpose.
Single-line comments starts with two forward slashes ( // ). Any text between // and the end of the line is ignored by Kotlin (will not be executed).
Kotlin have different syntax for linking. Base on kotlinlang.org
Instead of
{@link com.example.app.BlaActivity}
Use [
like this
[com.example.app.BlaActivity]
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With