dokka icon indicating copy to clipboard operation
dokka copied to clipboard

Ability to reference symbols from within a block of code

Open qwwdfsad opened this issue 10 months ago • 0 comments

Is your feature request related to a problem? Please describe

We have documentation where we want to explain that the entity lies in an open interval defined by the corresponding constants. We want to both express it in a Kotlin-friendly way and make them referenceable and lined.

We have two options (I use ' as a backtick, otherwise GH render breaks):

  1. "Foo is within 'DISTANT_PAST..DISTANT_FUTURE'". Renders as a range, but constants are not linked at all
  2. "Foo is within [DISTANT_PAST]..[DISTANT_FUTURE]". Renders as two links and a weird separator between them.

Describe the solution you'd like

It would be nice to find a solution that both renders as a code and provides the corresponding link targets. I have no specific suggestions ATM

qwwdfsad avatar Apr 19 '24 14:04 qwwdfsad