blob: 62c1cc8c2902d5b25207ff3bf46bf1ade9eb0eec (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
package org.jetbrains.dokka
import org.jetbrains.dokka.plugability.ConfigurableBlock
import org.jetbrains.dokka.utilities.parseJson
import org.jetbrains.dokka.utilities.serializeAsCompactJson
import org.jetbrains.dokka.utilities.serializeAsPrettyJson
fun DokkaConfigurationImpl(json: String): DokkaConfigurationImpl = parseJson(json)
fun GlobalDokkaConfiguration(json: String): GlobalDokkaConfiguration = parseJson(json)
@Deprecated("Renamed to better distinguish between compact/pretty prints", ReplaceWith("this.toCompactJsonString()"))
fun DokkaConfiguration.toJsonString(): String = this.toCompactJsonString()
@Deprecated("Renamed to better distinguish between compact/pretty prints", ReplaceWith("this.toCompactJsonString()"))
fun <T : ConfigurableBlock> T.toJsonString(): String = this.toCompactJsonString()
/**
* Serializes [DokkaConfiguration] as a machine-readable and compact JSON string.
*
* The returned string is not very human friendly as it will be difficult to parse by eyes due to it
* being compact and in one line. If you want to show the output to a human being, see [toPrettyJsonString].
*/
fun DokkaConfiguration.toCompactJsonString(): String = serializeAsCompactJson(this)
/**
* Serializes [DokkaConfiguration] as a human-readable (pretty printed) JSON string.
*
* The returned string will have excessive line breaks and indents, which might not be
* desirable when passing this value between API consumers/producers. If you want
* a machine-readable and compact json string, see [toCompactJsonString].
*/
fun DokkaConfiguration.toPrettyJsonString(): String = serializeAsPrettyJson(this)
/**
* Serializes a [ConfigurableBlock] as a machine-readable and compact JSON string.
*
* The returned string is not very human friendly as it will be difficult to parse by eyes due to it
* being compact and in one line. If you want to show the output to a human being, see [toPrettyJsonString].
*/
fun <T : ConfigurableBlock> T.toCompactJsonString(): String = serializeAsCompactJson(this)
/**
* Serializes a [ConfigurableBlock] as a human-readable (pretty printed) JSON string.
*
* The returned string will have excessive line breaks and indents, which might not be
* desirable when passing this value between API consumers/producers. If you want
* a machine-readable and compact json string, see [toCompactJsonString].
*/
fun <T : ConfigurableBlock> T.toPrettyJsonString(): String = serializeAsCompactJson(this)
|
