Docstrings added for Magic functions

gchq · Mar 12, 2020 · 5b6a53b · 5b6a53b
1 parent 5b5105c
commit 5b6a53b
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/src/core/lib/Magic.mjs b/src/core/lib/Magic.mjs
@@ -29,8 +29,11 @@ class Magic {
     }
 
     /**
+     * Finds operations that claim to be able to decode the input based on
+     * regular expression matches.
      *
-     * @param opPatterns
+     * @param {[Object]} opPatterns
+     * @returns {Array}
      */
     inputRegexMatch(opPatterns) {
         const matches = [];
@@ -48,7 +51,11 @@ class Magic {
     }
 
     /**
+     * Finds operations that claim to be able to decode the input based on entropy
+     * matches.
      *
+     * @param {[Object]} opPatterns
+     * @returns {Array}
      */
     entropyInputMatch(opPatterns) {
         const matches = [];
@@ -64,8 +71,7 @@ class Magic {
     }
 
     /**
-     * Finds operations that claim to be able to decode the input based on regular
-     * expression matches.
+     * Finds operations that claim to be able to decode the input based on criteria.
      *
      * @returns {Object[]}
      */