mirror of
https://github.com/DanilaFe/abacus
synced 2025-04-21 16:18:44 -07:00
Create a documentation object class.
This commit is contained in:
parent
b45c7e2d1b
commit
b83a8c7b33
15
src/main/kotlin/org/nwapw/abacus/function/Documentation.kt
Normal file
15
src/main/kotlin/org/nwapw/abacus/function/Documentation.kt
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
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)
|
Loading…
Reference in New Issue
Block a user