From 4247ddb0cee9617d04d67ccb6d8bce3589774dad Mon Sep 17 00:00:00 2001 From: n1073645 Date: Mon, 6 Jan 2020 10:36:16 +0000 Subject: [PATCH] Documenting the library function --- src/core/lib/MagicCriteria.mjs | 7 +++++++ src/core/lib/MagicObject.mjs | 10 +++++++--- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/src/core/lib/MagicCriteria.mjs b/src/core/lib/MagicCriteria.mjs index b9193b1a..78497d08 100644 --- a/src/core/lib/MagicCriteria.mjs +++ b/src/core/lib/MagicCriteria.mjs @@ -1,3 +1,10 @@ +/** + * Constants for the entropy of text. + * + * @author n1073645 [n1073645@gmail.com] + * @copyright Crown Copyright 2020 + * @license Apache-2.0 + */ export const compressedToDecompressed = { input: [6.5, 8], output: [3.5, 6] diff --git a/src/core/lib/MagicObject.mjs b/src/core/lib/MagicObject.mjs index 6fa0feed..736b2647 100644 --- a/src/core/lib/MagicObject.mjs +++ b/src/core/lib/MagicObject.mjs @@ -1,8 +1,12 @@ +/** + * An object used by magic to store the input/output criteria for valid operation results. + * + * @author n1073645 [n1073645@gmail.com] + * @copyright Crown Copyright 2020 + * @license Apache-2.0 + */ import OperationConfig from "../config/OperationConfig.json"; -/** - * An object used by magic to store the input/output criteria for valid operation results. - */ class potentialOps { /**