kdoc link to local file so that link works in Android Studio

258 views Asked by At

In Kotlin doc comments I can link to a website

/**
 * [go to this website](https://www.google.com)
 */

I can link to a class

/**
 * [look at this class][SomeClass]
 */

But how can I link to a file in the repository such that clicking it in Android Studio opens the file?

/**
 * [see our documentation](../ourDocs.md) 
 * [see our documentation](file:/absolute/path/to/ourDocs.md)
 * neither works, makes a link but click does nothing
 */
0

There are 0 answers