Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove irrelevant JavaDoc #243

Merged
merged 3 commits into from
Dec 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@ 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)
* @param string YAML data to load from
* @return parsed instance
* @throws it.krzeminski.snakeyaml.engine.kmp.exceptions.YamlEngineException if the YAML is not valid
*/
Expand All @@ -40,13 +38,10 @@ expect class Load(
internal fun loadOne(source: Source): Any?

/**
* Parse all YAML documents in a String and produce corresponding objects. (Because the
* 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.
* Parse all YAML documents in a String and produce corresponding objects.
* The documents are parsed only when the iterator is invoked.
*
* @param string YAML data to load from (BOM must not be present)
* @param string YAML data to load from
* @return an [Iterable] over the parsed objects in this stream in proper sequence
*/
fun loadAll(string: String): Iterable<Any?>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@ 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)
* @param string YAML data to load from
* @return parsed instance
* @throws it.krzeminski.snakeyaml.engine.kmp.exceptions.YamlEngineException if the YAML is not valid
*/
Expand All @@ -64,13 +62,10 @@ internal class LoadCommon(
Iterable { YamlIterator(composer, constructor) }

/**
* Parse all YAML documents in a String and produce corresponding objects. (Because the
* 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.
* Parse all YAML documents in a String and produce corresponding objects.
* The documents are parsed only when the iterator is invoked.
*
* @param string YAML data to load from (BOM must not be present)
* @param string YAML data to load from
* @return an [Iterable] over the parsed objects in this stream in proper sequence
*/
fun loadAll(string: String): Iterable<Any?> =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ expect class Parse(
*
* See [Processing Overview](http://www.yaml.org/spec/1.2/spec.html.id2762107).
*
* @param string YAML document(s). The BOM must not be present (it will be parsed as content)
* @param string YAML document(s)
* @return parsed events
*/
fun parse(string: String): Iterable<Event>
Expand All @@ -22,7 +22,7 @@ expect class Parse(
*
* See [Processing Overview](http://www.yaml.org/spec/1.2/spec.html.id2762107).
*
* @param source YAML document(s). The BOM must not be present (it will be parsed as content)
* @param source YAML document(s)
* @return parsed events
*/
fun parse(source: Source): Iterable<Event>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class ParseString(
*
* See [Processing Overview](http://www.yaml.org/spec/1.2/spec.html.id2762107).
*
* @param yaml - YAML document(s). The BOM must not be present (it will be parsed as content)
* @param yaml - YAML document(s).
* @return parsed events
*/
fun parseString(yaml: String): Iterable<Event> = parse.parse(yaml)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ actual class Load @JvmOverloads actual constructor(
/**
* Parse a YAML document and create a object instance.
*
* @param reader data to load from (BOM must not be present)
* @param reader data to load from
* @return parsed object instance
*/
fun loadOne(reader: Reader): Any? =
Expand All @@ -80,7 +80,7 @@ actual class Load @JvmOverloads actual constructor(
* Parse all YAML documents in a String and produce corresponding objects. The documents are
* parsed only when the iterator is invoked.
*
* @param reader YAML data to load from (BOM must not be present)
* @param reader YAML data to load from
* @return an [Iterable] over the parsed objects in this stream in proper sequence
*/
fun loadAll(reader: Reader): Iterable<Any?> =
Expand Down
Loading