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/base/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/base/api')
| -rw-r--r-- | plugins/base/api/base.api | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/plugins/base/api/base.api b/plugins/base/api/base.api index 101a00e9..4b68b3d7 100644 --- a/plugins/base/api/base.api +++ b/plugins/base/api/base.api @@ -1503,6 +1503,10 @@ public class org/jetbrains/dokka/base/translators/documentables/PageContentBuild public final fun buildGroup (Ljava/util/Set;Ljava/util/Set;Lorg/jetbrains/dokka/pages/Kind;Ljava/util/Set;Lorg/jetbrains/dokka/model/properties/PropertyContainer;Lkotlin/jvm/functions/Function1;)Lorg/jetbrains/dokka/pages/ContentGroup; public static synthetic fun buildGroup$default (Lorg/jetbrains/dokka/base/translators/documentables/PageContentBuilder$DocumentableContentBuilder;Ljava/util/Set;Ljava/util/Set;Lorg/jetbrains/dokka/pages/Kind;Ljava/util/Set;Lorg/jetbrains/dokka/model/properties/PropertyContainer;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lorg/jetbrains/dokka/pages/ContentGroup; public final fun buildSignature (Lorg/jetbrains/dokka/model/Documentable;)Ljava/util/List; + public final fun codeBlock (Ljava/lang/String;Lorg/jetbrains/dokka/pages/Kind;Ljava/util/Set;Ljava/util/Set;Lorg/jetbrains/dokka/model/properties/PropertyContainer;Lkotlin/jvm/functions/Function1;)V + public static synthetic fun codeBlock$default (Lorg/jetbrains/dokka/base/translators/documentables/PageContentBuilder$DocumentableContentBuilder;Ljava/lang/String;Lorg/jetbrains/dokka/pages/Kind;Ljava/util/Set;Ljava/util/Set;Lorg/jetbrains/dokka/model/properties/PropertyContainer;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)V + public final fun codeInline (Ljava/lang/String;Lorg/jetbrains/dokka/pages/Kind;Ljava/util/Set;Ljava/util/Set;Lorg/jetbrains/dokka/model/properties/PropertyContainer;Lkotlin/jvm/functions/Function1;)V + public static synthetic fun codeInline$default (Lorg/jetbrains/dokka/base/translators/documentables/PageContentBuilder$DocumentableContentBuilder;Ljava/lang/String;Lorg/jetbrains/dokka/pages/Kind;Ljava/util/Set;Ljava/util/Set;Lorg/jetbrains/dokka/model/properties/PropertyContainer;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)V public final fun comment (Lorg/jetbrains/dokka/model/doc/DocTag;Lorg/jetbrains/dokka/pages/Kind;Ljava/util/Set;Ljava/util/Set;Lorg/jetbrains/dokka/model/properties/PropertyContainer;)V public static synthetic fun comment$default (Lorg/jetbrains/dokka/base/translators/documentables/PageContentBuilder$DocumentableContentBuilder;Lorg/jetbrains/dokka/model/doc/DocTag;Lorg/jetbrains/dokka/pages/Kind;Ljava/util/Set;Ljava/util/Set;Lorg/jetbrains/dokka/model/properties/PropertyContainer;ILjava/lang/Object;)V public final fun constant (Ljava/lang/String;)V |