Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to represent hyperlink in kDoc

Tags:

href

kotlin

kdoc

In Javadoc I can represent a hyperlink as @see <a href="http://google.com">http://google.com</a>. How can I do this in Kotlin?

like image 349
salyela Avatar asked Nov 05 '18 19:11

salyela


1 Answers

Well, actually, hyperlinks and @see tags are two separate matters in KDoc, meaning that @see is only limited to API references:

/**
 * @see [Object.toString]
 */
class C

Hyperlinks per se use the regular Markdown syntax (but, unlike JavaDoc, can't be mixed with @see tags):

/**
 * **See Also:** [Google](http://google.com)
 */
class C
like image 171
Bass Avatar answered Oct 21 '22 08:10

Bass