Skip to content

Commit

Permalink
Remove irrelevant JavaDoc
Browse files Browse the repository at this point in the history
Strings are never UTF-8 encoded.
Strings are a sequence of Unicode characters.
If these Unicode characters are encoded into a sequence of bytes
or decoded from a sequence of bytes, then encodings like UTF-8 come into play.
  • Loading branch information
Vampire committed Sep 23, 2024
1 parent 321fcaa commit 66042b5
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ expect class Load(
/**
* Parse a YAML document and create an instance of an object.
*
* The string must be encoded as UTF-8.
*
* @param string YAML data to load from (BOM must not be present)
* @return parsed instance
* @throws it.krzeminski.snakeyaml.engine.kmp.exceptions.YamlEngineException if the YAML is not valid
Expand All @@ -44,8 +42,6 @@ expect class Load(
* encoding in known BOM is not respected.) The documents are parsed only when the iterator is
* invoked.
*
* The string must be encoded as UTF-8.
*
* @param string YAML data to load from (BOM must not be present)
* @return an [Iterable] over the parsed objects in this stream in proper sequence
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ internal class LoadCommon(
/**
* Parse a YAML document and create an instance of an object.
*
* The string must be encoded as UTF-8.
*
* @param string YAML data to load from (BOM must not be present)
* @return parsed instance
* @throws it.krzeminski.snakeyaml.engine.kmp.exceptions.YamlEngineException if the YAML is not valid
Expand All @@ -68,8 +66,6 @@ internal class LoadCommon(
* encoding in known BOM is not respected.) The documents are parsed only when the iterator is
* invoked.
*
* The string must be encoded as UTF-8.
*
* @param string YAML data to load from (BOM must not be present)
* @return an [Iterable] over the parsed objects in this stream in proper sequence
*/
Expand Down

0 comments on commit 66042b5

Please sign in to comment.