Improve writeCodePointValue KDoc (#314)

fzhinkin · web-flow · commit f36dd273e410 · 2024-05-07T12:33:05.000+02:00
diff --git a/core/common/src/Utf8.kt b/core/common/src/Utf8.kt
@@ -130,6 +130,9 @@ internal fun String.utf8Size(startIndex: Int = 0, endIndex: Int = length): Long
  * Without such a conversion, data written to a [Sink] can not be converted back
  * to a string from which a surrogate pair was retrieved.
  *
+ * More specifically, all code points mapping to UTF-16 surrogates (`U+d800`..`U+dfff`)
+ * will be written as `?` characters (`U+0063`).
+ *
  * @param codePoint the codePoint to be written.
  *
  * @throws IllegalStateException when the sink is closed.

Original file line number	Diff line number	Diff line change
`@@ -130,6 +130,9 @@ internal fun String.utf8Size(startIndex: Int = 0, endIndex: Int = length): Long`
`130`	`130`	`* Without such a conversion, data written to a [Sink] can not be converted back`
`131`	`131`	`* to a string from which a surrogate pair was retrieved.`
`132`	`132`	`*`
	`133`	+ * More specifically, all code points mapping to UTF-16 surrogates (`U+d800`..`U+dfff`)
	`134`	+ * will be written as `?` characters (`U+0063`).
	`135`	`+ *`
`133`	`136`	`* @param codePoint the codePoint to be written.`
`134`	`137`	`*`
`135`	`138`	`* @throws IllegalStateException when the sink is closed.`