mirror of https://github.com/DanilaFe/abacus
26 lines
1.0 KiB
Kotlin
26 lines
1.0 KiB
Kotlin
package org.nwapw.abacus.function
|
|
|
|
/**
|
|
* A data class used for storing information about a function.
|
|
*
|
|
* The Documentation class holds the information necessary to display the information
|
|
* about a function to the user.
|
|
*
|
|
* @param codeName the name of the function as it occurs in code.
|
|
* @param name the name of the function in English.
|
|
* @param description the short description of this function.
|
|
* @param longDescription the full description of this function.
|
|
* @param type the things this documentation maps to.
|
|
*/
|
|
data class Documentation(val codeName: String, val name: String,
|
|
val description: String, val longDescription: String,
|
|
val type: DocumentationType) {
|
|
|
|
fun matches(other: String): Boolean {
|
|
return codeName.toLowerCase().contains(other.toLowerCase()) ||
|
|
name.toLowerCase().contains(other.toLowerCase()) ||
|
|
description.toLowerCase().contains(other.toLowerCase()) ||
|
|
longDescription.toLowerCase().contains(other.toLowerCase())
|
|
}
|
|
|
|
} |