dokka
dokka copied to clipboard
Kotlin
Allowing external links in @see
Is your feature request related to a problem? Please describe
I'm trying to reference an external doc using @see, but can't. It would be nice if @see has support for external urls, or if an annotation can be provided to support this.
Describe the solution you'd like I'd expect:
/**
* This is an example of my docs.
*
* @see [MyLink](http://google.com)
* @see [MyLink2](http://bing.com)
* @see [MyLink3](http://yahoo.com)
* @see com.github.myproject.SeeOtherClass
*/
To generate docs that users can click to visit MyLink.
Describe alternatives you've considered I could manually create the "See Also"... but it's annoying/looks ugly:
/**
* This is an example of my docs.
*
* **See Also**
*
* [MyLink](http://google.com)
*
* [MyLink2](http://bing.com)
*
* [MyLink3](http://yahoo.com)
*
* [com.github.myproject.SeeOtherClass]
*/
Additional context N/A
This is not something that is in KDoc specification, which is a part of the language standard. Nevertheless, something like that can be achieved using plugins api.
In case anyone finds this after all this time, this works:
/**
* See [GitHub](https://github.com)
*/
It doesn't work with the @see, though.
In case anyone finds this after all this time, this works:
/** * See [GitHub](https://github.com) */It doesn't work with the
@see, though.
Tried this with an URL including a path and for some reason the generator always adds ".html" to it without a good reason.
Common use-case from the standard library:
@see [Kotlin language documentation](link to kotlinlang.org with detailed description of the API and examples, that we cannot afford to put into KDoc)
With dokka 1.9.10, @see [xxx](https://xxxx) works, but @see [x-x](https://xxxx) doesn't work. See [x-x](https://xxxx) works.
@RationalityFrontline can you clarify what exactly doesn't work? Is it the presence of the - character that breaks the link?
@RationalityFrontline can you clarify what exactly doesn't work? Is it the presence of the
-character that breaks the link?
yes, it's the '-' character.