ReVanced/revanced-patcher
1
0
Fork 0
mirror of https://github.com/revanced/revanced-patcher.git synced 2025-05-02 14:04:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: Add missing inline docs

Browse Source
This commit is contained in:
oSumAtrIX 2023-10-21 23:49:40 +02:00
parent 155e787ff4
commit f28bfe0dbd
No known key found for this signature in database
GPG Key ID: A9B3094ACDB604B4
10 changed files with 66 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/main/kotlin/app/revanced/patcher/patch/options/types/BooleanPatchOption.kt
View File

@ -11,6 +11,7 @@ import app.revanced.patcher.patch.options.PatchOption
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
* *
* @see PatchOption * @see PatchOption
*/ */
@ -20,8 +21,8 @@ class BooleanPatchOption private constructor(
title: String?, title: String?,
description: String?, description: String?,
required: Boolean, required: Boolean,
validator: (Boolean?) -> Boolean validate: (Boolean?) -> Boolean
) : PatchOption<Boolean>(key, default, title, description, required, validator) { ) : PatchOption<Boolean>(key, default, title, description, required, validate) {
companion object { companion object {
/** /**
* Create a new [BooleanPatchOption] and add it to the current [Patch]. * Create a new [BooleanPatchOption] and add it to the current [Patch].
@ -42,7 +43,7 @@ class BooleanPatchOption private constructor(
title: String? = null, title: String? = null,
description: String? = null, description: String? = null,
required: Boolean = false, required: Boolean = false,
validator: (Boolean?) -> Boolean = { true } validate: (Boolean?) -> Boolean = { true }
) = BooleanPatchOption(key, default, title, description, required, validator).also { options.register(it) } ) = BooleanPatchOption(key, default, title, description, required, validate).also { options.register(it) }
} }
} }

11
src/main/kotlin/app/revanced/patcher/patch/options/types/FloatPatchOption.kt
View File

@ -11,6 +11,7 @@ import app.revanced.patcher.patch.options.PatchOption
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
* *
* @see PatchOption * @see PatchOption
*/ */
@ -20,8 +21,8 @@ class FloatPatchOption private constructor(
title: String?, title: String?,
description: String?, description: String?,
required: Boolean, required: Boolean,
validator: (Float?) -> Boolean validate: (Float?) -> Boolean
) : PatchOption<Float>(key, default, title, description, required, validator) { ) : PatchOption<Float>(key, default, title, description, required, validate) {
companion object { companion object {
/** /**
* Create a new [FloatPatchOption] and add it to the current [Patch]. * Create a new [FloatPatchOption] and add it to the current [Patch].
@ -31,6 +32,8 @@ class FloatPatchOption private constructor(
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
*
* @return The created [FloatPatchOption]. * @return The created [FloatPatchOption].
* *
* @see FloatPatchOption * @see FloatPatchOption
@ -42,7 +45,7 @@ class FloatPatchOption private constructor(
title: String? = null, title: String? = null,
description: String? = null, description: String? = null,
required: Boolean = false, required: Boolean = false,
validator: (Float?) -> Boolean = { true } validate: (Float?) -> Boolean = { true }
) = FloatPatchOption(key, default, title, description, required, validator).also { options.register(it) } ) = FloatPatchOption(key, default, title, description, required, validate).also { options.register(it) }
} }
} }

11
src/main/kotlin/app/revanced/patcher/patch/options/types/IntPatchOption.kt
View File

@ -11,6 +11,7 @@ import app.revanced.patcher.patch.options.PatchOption
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
* *
* @see PatchOption * @see PatchOption
*/ */
@ -20,8 +21,8 @@ class IntPatchOption private constructor(
title: String?, title: String?,
description: String?, description: String?,
required: Boolean, required: Boolean,
validator: (Int?) -> Boolean validate: (Int?) -> Boolean
) : PatchOption<Int>(key, default, title, description, required, validator) { ) : PatchOption<Int>(key, default, title, description, required, validate) {
companion object { companion object {
/** /**
* Create a new [IntPatchOption] and add it to the current [Patch]. * Create a new [IntPatchOption] and add it to the current [Patch].
@ -31,6 +32,8 @@ class IntPatchOption private constructor(
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
*
* @return The created [IntPatchOption]. * @return The created [IntPatchOption].
* *
* @see IntPatchOption * @see IntPatchOption
@ -42,7 +45,7 @@ class IntPatchOption private constructor(
title: String? = null, title: String? = null,
description: String? = null, description: String? = null,
required: Boolean = false, required: Boolean = false,
validator: (Int?) -> Boolean = { true } validate: (Int?) -> Boolean = { true }
) = IntPatchOption(key, default, title, description, required, validator).also { options.register(it) } ) = IntPatchOption(key, default, title, description, required, validate).also { options.register(it) }
} }
} }

9
src/main/kotlin/app/revanced/patcher/patch/options/types/LongPatchOption.kt
View File

@ -11,6 +11,7 @@ import app.revanced.patcher.patch.options.PatchOption
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
* *
* @see PatchOption * @see PatchOption
*/ */
@ -20,8 +21,8 @@ class LongPatchOption private constructor(
title: String?, title: String?,
description: String?, description: String?,
required: Boolean, required: Boolean,
validator: (Long?) -> Boolean validate: (Long?) -> Boolean
) : PatchOption<Long>(key, default, title, description, required, validator) { ) : PatchOption<Long>(key, default, title, description, required, validate) {
companion object { companion object {
/** /**
* Create a new [LongPatchOption] and add it to the current [Patch]. * Create a new [LongPatchOption] and add it to the current [Patch].
@ -42,7 +43,7 @@ class LongPatchOption private constructor(
title: String? = null, title: String? = null,
description: String? = null, description: String? = null,
required: Boolean = false, required: Boolean = false,
validator: (Long?) -> Boolean = { true } validate: (Long?) -> Boolean = { true }
) = LongPatchOption(key, default, title, description, required, validator).also { options.register(it) } ) = LongPatchOption(key, default, title, description, required, validate).also { options.register(it) }
} }
} }

11
src/main/kotlin/app/revanced/patcher/patch/options/types/StringPatchOption.kt
View File

@ -11,6 +11,7 @@ import app.revanced.patcher.patch.options.PatchOption
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
* *
* @see PatchOption * @see PatchOption
*/ */
@ -20,8 +21,8 @@ class StringPatchOption private constructor(
title: String?, title: String?,
description: String?, description: String?,
required: Boolean, required: Boolean,
validator: (String?) -> Boolean validate: (String?) -> Boolean
) : PatchOption<String>(key, default, title, description, required, validator) { ) : PatchOption<String>(key, default, title, description, required, validate) {
companion object { companion object {
/** /**
* Create a new [StringPatchOption] and add it to the current [Patch]. * Create a new [StringPatchOption] and add it to the current [Patch].
@ -31,6 +32,8 @@ class StringPatchOption private constructor(
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
*
* @return The created [StringPatchOption]. * @return The created [StringPatchOption].
* *
* @see StringPatchOption * @see StringPatchOption
@ -42,7 +45,7 @@ class StringPatchOption private constructor(
title: String? = null, title: String? = null,
description: String? = null, description: String? = null,
required: Boolean = false, required: Boolean = false,
validator: (String?) -> Boolean = { true } validate: (String?) -> Boolean = { true }
) = StringPatchOption(key, default, title, description, required, validator).also { options.register(it) } ) = StringPatchOption(key, default, title, description, required, validate).also { options.register(it) }
} }
} }

11
src/main/kotlin/app/revanced/patcher/patch/options/types/array/BooleanArrayPatchOption.kt
View File

@ -11,6 +11,7 @@ import app.revanced.patcher.patch.options.PatchOption
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
* *
* @see PatchOption * @see PatchOption
*/ */
@ -20,8 +21,8 @@ class BooleanArrayPatchOption private constructor(
title: String?, title: String?,
description: String?, description: String?,
required: Boolean, required: Boolean,
validator: (Array<Boolean>?) -> Boolean validate: (Array<Boolean>?) -> Boolean
) : PatchOption<Array<Boolean>>(key, default, title, description, required, validator) { ) : PatchOption<Array<Boolean>>(key, default, title, description, required, validate) {
companion object { companion object {
/** /**
* Create a new [BooleanArrayPatchOption] and add it to the current [Patch]. * Create a new [BooleanArrayPatchOption] and add it to the current [Patch].
@ -31,6 +32,8 @@ class BooleanArrayPatchOption private constructor(
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
*
* @return The created [BooleanArrayPatchOption]. * @return The created [BooleanArrayPatchOption].
* *
* @see BooleanArrayPatchOption * @see BooleanArrayPatchOption
@ -42,7 +45,7 @@ class BooleanArrayPatchOption private constructor(
title: String? = null, title: String? = null,
description: String? = null, description: String? = null,
required: Boolean = false, required: Boolean = false,
validator: (Array<Boolean>?) -> Boolean = { true } validate: (Array<Boolean>?) -> Boolean = { true }
) = BooleanArrayPatchOption(key, default, title, description, required, validator).also { options.register(it) } ) = BooleanArrayPatchOption(key, default, title, description, required, validate).also { options.register(it) }
} }
} }

11
src/main/kotlin/app/revanced/patcher/patch/options/types/array/FloatArrayPatchOption.kt
View File

@ -11,6 +11,7 @@ import app.revanced.patcher.patch.options.PatchOption
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
* *
* @see PatchOption * @see PatchOption
*/ */
@ -20,8 +21,8 @@ class FloatArrayPatchOption private constructor(
title: String?, title: String?,
description: String?, description: String?,
required: Boolean, required: Boolean,
validator: (Array<Float>?) -> Boolean validate: (Array<Float>?) -> Boolean
) : PatchOption<Array<Float>>(key, default, title, description, required, validator) { ) : PatchOption<Array<Float>>(key, default, title, description, required, validate) {
companion object { companion object {
/** /**
* Create a new [FloatArrayPatchOption] and add it to the current [Patch]. * Create a new [FloatArrayPatchOption] and add it to the current [Patch].
@ -31,6 +32,8 @@ class FloatArrayPatchOption private constructor(
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
*
* @return The created [FloatArrayPatchOption]. * @return The created [FloatArrayPatchOption].
* *
* @see FloatArrayPatchOption * @see FloatArrayPatchOption
@ -42,7 +45,7 @@ class FloatArrayPatchOption private constructor(
title: String? = null, title: String? = null,
description: String? = null, description: String? = null,
required: Boolean = false, required: Boolean = false,
validator: (Array<Float>?) -> Boolean = { true } validate: (Array<Float>?) -> Boolean = { true }
) = FloatArrayPatchOption(key, default, title, description, required, validator).also { options.register(it) } ) = FloatArrayPatchOption(key, default, title, description, required, validate).also { options.register(it) }
} }
} }

11
src/main/kotlin/app/revanced/patcher/patch/options/types/array/IntArrayPatchOption.kt
View File

@ -11,6 +11,7 @@ import app.revanced.patcher.patch.options.PatchOption
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
* *
* @see PatchOption * @see PatchOption
*/ */
@ -20,8 +21,8 @@ class IntArrayPatchOption private constructor(
title: String?, title: String?,
description: String?, description: String?,
required: Boolean, required: Boolean,
validator: (Array<Int>?) -> Boolean validate: (Array<Int>?) -> Boolean
) : PatchOption<Array<Int>>(key, default, title, description, required, validator) { ) : PatchOption<Array<Int>>(key, default, title, description, required, validate) {
companion object { companion object {
/** /**
* Create a new [IntArrayPatchOption] and add it to the current [Patch]. * Create a new [IntArrayPatchOption] and add it to the current [Patch].
@ -31,6 +32,8 @@ class IntArrayPatchOption private constructor(
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
*
* @return The created [IntArrayPatchOption]. * @return The created [IntArrayPatchOption].
* *
* @see IntArrayPatchOption * @see IntArrayPatchOption
@ -42,7 +45,7 @@ class IntArrayPatchOption private constructor(
title: String? = null, title: String? = null,
description: String? = null, description: String? = null,
required: Boolean = false, required: Boolean = false,
validator: (Array<Int>?) -> Boolean = { true } validate: (Array<Int>?) -> Boolean = { true }
) = IntArrayPatchOption(key, default, title, description, required, validator).also { options.register(it) } ) = IntArrayPatchOption(key, default, title, description, required, validate).also { options.register(it) }
} }
} }

11
src/main/kotlin/app/revanced/patcher/patch/options/types/array/LongArrayPatchOption.kt
View File

@ -11,6 +11,7 @@ import app.revanced.patcher.patch.options.PatchOption
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
* *
* @see PatchOption * @see PatchOption
*/ */
@ -20,8 +21,8 @@ class LongArrayPatchOption private constructor(
title: String?, title: String?,
description: String?, description: String?,
required: Boolean, required: Boolean,
validator: (Array<Long>?) -> Boolean validate: (Array<Long>?) -> Boolean
) : PatchOption<Array<Long>>(key, default, title, description, required, validator) { ) : PatchOption<Array<Long>>(key, default, title, description, required, validate) {
companion object { companion object {
/** /**
* Create a new [LongArrayPatchOption] and add it to the current [Patch]. * Create a new [LongArrayPatchOption] and add it to the current [Patch].
@ -31,6 +32,8 @@ class LongArrayPatchOption private constructor(
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
*
* @return The created [LongArrayPatchOption]. * @return The created [LongArrayPatchOption].
* *
* @see LongArrayPatchOption * @see LongArrayPatchOption
@ -42,7 +45,7 @@ class LongArrayPatchOption private constructor(
title: String? = null, title: String? = null,
description: String? = null, description: String? = null,
required: Boolean = false, required: Boolean = false,
validator: (Array<Long>?) -> Boolean = { true } validate: (Array<Long>?) -> Boolean = { true }
) = LongArrayPatchOption(key, default, title, description, required, validator).also { options.register(it) } ) = LongArrayPatchOption(key, default, title, description, required, validate).also { options.register(it) }
} }
} }

11
src/main/kotlin/app/revanced/patcher/patch/options/types/array/StringArrayPatchOption.kt
View File

@ -11,6 +11,7 @@ import app.revanced.patcher.patch.options.PatchOption
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
* *
* @see PatchOption * @see PatchOption
*/ */
@ -20,8 +21,8 @@ class StringArrayPatchOption private constructor(
title: String?, title: String?,
description: String?, description: String?,
required: Boolean, required: Boolean,
validator: (Array<String>?) -> Boolean validate: (Array<String>?) -> Boolean
) : PatchOption<Array<String>>(key, default, title, description, required, validator) { ) : PatchOption<Array<String>>(key, default, title, description, required, validate) {
companion object { companion object {
/** /**
* Create a new [StringArrayPatchOption] and add it to the current [Patch]. * Create a new [StringArrayPatchOption] and add it to the current [Patch].
@ -31,6 +32,8 @@ class StringArrayPatchOption private constructor(
* @param title The title. * @param title The title.
* @param description A description. * @param description A description.
* @param required Whether the option is required. * @param required Whether the option is required.
* @param validate The function to validate values of the option.
*
* @return The created [StringArrayPatchOption]. * @return The created [StringArrayPatchOption].
* *
* @see StringArrayPatchOption * @see StringArrayPatchOption
@ -42,7 +45,7 @@ class StringArrayPatchOption private constructor(
title: String? = null, title: String? = null,
description: String? = null, description: String? = null,
required: Boolean = false, required: Boolean = false,
validator: (Array<String>?) -> Boolean = { true } validate: (Array<String>?) -> Boolean = { true }
) = StringArrayPatchOption(key, default, title, description, required, validator).also { options.register(it) } ) = StringArrayPatchOption(key, default, title, description, required, validate).also { options.register(it) }
} }
} }