diff options
| author | Don Cross <cosinekitty@users.noreply.github.com> | 2022-05-04 12:33:21 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-04 19:33:21 +0300 |
| commit | 3fb60bc74a4ed4e4c795f2f14fa112321a3c94cc (patch) | |
| tree | 8ca1c8f5147a1a15fa577898594d496a2f330c83 /plugins/gfm/api/gfm.api | |
| parent | 6046abccab85f2cfde5e20476d3b9ea1b1ab1ff9 (diff) | |
| download | dokka-3fb60bc74a4ed4e4c795f2f14fa112321a3c94cc.tar.gz dokka-3fb60bc74a4ed4e4c795f2f14fa112321a3c94cc.tar.bz2 dokka-3fb60bc74a4ed4e4c795f2f14fa112321a3c94cc.zip | |
Support code blocks and inline code for GFM format (#2485)
Fixes #2477.
Inline code, text that is nested within a pair of backquotes,
is now converted into GitHub Flavored Markdown (gfm) without
stripping out the backquotes. For example:
The parameter `sum` must be a non-negative real number.
Code blocks, which are any number of lines of literal text
between triple-backquotes, and an optional programming language
name, are now preserved. If absent, the programming language
is assumed to be "kotlin". This follows the behavior of the
html renderer. For example:
Here is an example of calling the function:
```kotlin
val sum = addThemUp(left, right)
```
Diffstat (limited to 'plugins/gfm/api/gfm.api')
| -rw-r--r-- | plugins/gfm/api/gfm.api | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/plugins/gfm/api/gfm.api b/plugins/gfm/api/gfm.api index ba189898..b6970211 100644 --- a/plugins/gfm/api/gfm.api +++ b/plugins/gfm/api/gfm.api @@ -41,6 +41,10 @@ public final class org/jetbrains/dokka/gfm/renderer/BriefCommentPreprocessor : o public class org/jetbrains/dokka/gfm/renderer/CommonmarkRenderer : org/jetbrains/dokka/base/renderers/DefaultRenderer { public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V + public synthetic fun buildCodeBlock (Ljava/lang/Object;Lorg/jetbrains/dokka/pages/ContentCodeBlock;Lorg/jetbrains/dokka/pages/ContentPage;)V + public fun buildCodeBlock (Ljava/lang/StringBuilder;Lorg/jetbrains/dokka/pages/ContentCodeBlock;Lorg/jetbrains/dokka/pages/ContentPage;)V + public synthetic fun buildCodeInline (Ljava/lang/Object;Lorg/jetbrains/dokka/pages/ContentCodeInline;Lorg/jetbrains/dokka/pages/ContentPage;)V + public fun buildCodeInline (Ljava/lang/StringBuilder;Lorg/jetbrains/dokka/pages/ContentCodeInline;Lorg/jetbrains/dokka/pages/ContentPage;)V public synthetic fun buildDRILink (Ljava/lang/Object;Lorg/jetbrains/dokka/pages/ContentDRILink;Lorg/jetbrains/dokka/pages/ContentPage;Ljava/util/Set;)V public fun buildDRILink (Ljava/lang/StringBuilder;Lorg/jetbrains/dokka/pages/ContentDRILink;Lorg/jetbrains/dokka/pages/ContentPage;Ljava/util/Set;)V public synthetic fun buildDivergent (Ljava/lang/Object;Lorg/jetbrains/dokka/pages/ContentDivergentGroup;Lorg/jetbrains/dokka/pages/ContentPage;)V |