chore: Improve wording

This commit is contained in:
oSumAtrIX
2023-12-07 02:29:46 +01:00
parent 99e90c02ed
commit bf5780e2f7

View File

@@ -15,9 +15,9 @@ object Options {
private var mapper = jacksonObjectMapper()
/**
* Serializes the options for the patches in the list.
* Serializes the options for a set of patches.
*
* @param patches The list of patches to serialize.
* @param patches The set of patches to serialize.
* @param prettyPrint Whether to pretty print the JSON.
* @return The JSON string containing the options.
*/
@@ -54,16 +54,16 @@ object Options {
}
/**
* Deserializes the options for the patches in the list.
* Deserializes the options to a set of patches.
*
* @param json The JSON string containing the options.
* @return The list of [Patch]s.
* @return A set of [Patch]s.
* @see Patch
*/
fun deserialize(json: String): Array<Patch> = mapper.readValue(json, Array<Patch>::class.java)
/**
* Sets the options for the patches in the list.
* Sets the options for a set of patches.
*
* @param json The JSON string containing the options.
*/
@@ -91,7 +91,7 @@ object Options {
}
/**
* Sets the options for the patches in the list.
* Sets the options for a set of patches.
*
* @param file The file containing the JSON string containing the options.
* @see setOptions