mirror of
https://github.com/DanilaFe/abacus
synced 2025-04-21 16:18:44 -07:00
15 lines
619 B
Kotlin
15 lines
619 B
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.
|
||
|
|
*/
|
||
|
|
data class Documentation(val codeName: String, val name: String,
|
||
|
|
val description: String, val longDescription: String)
|