DanilaFe/Abacus
1
0
Fork 0
mirror of https://github.com/DanilaFe/abacus synced 2024-11-17 16:09:32 -08:00
Code Issues Releases Wiki Activity

Create a documentation object class.

Browse Source
This commit is contained in:
Danila Fedorin 2017-08-07 22:30:32 -07:00
parent ff7d90967e
commit e61cfdca46
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/main/kotlin/org/nwapw/abacus/function/Documentation.kt Normal file
View 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)