From e61cfdca4638152f5219d5c92cb072031388658a Mon Sep 17 00:00:00 2001 From: Danila Fedorin Date: Mon, 7 Aug 2017 22:30:32 -0700 Subject: [PATCH] Create a documentation object class. --- .../org/nwapw/abacus/function/Documentation.kt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 src/main/kotlin/org/nwapw/abacus/function/Documentation.kt diff --git a/src/main/kotlin/org/nwapw/abacus/function/Documentation.kt b/src/main/kotlin/org/nwapw/abacus/function/Documentation.kt new file mode 100644 index 0000000..b1c384b --- /dev/null +++ b/src/main/kotlin/org/nwapw/abacus/function/Documentation.kt @@ -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) \ No newline at end of file