Docstrings added for Magic functions

This commit is contained in:
n1073645 2020-03-12 14:55:19 +00:00
parent 5b5105c864
commit 5b6a53be3e

View File

@ -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) { inputRegexMatch(opPatterns) {
const matches = []; 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) { entropyInputMatch(opPatterns) {
const matches = []; const matches = [];
@ -64,8 +71,7 @@ class Magic {
} }
/** /**
* Finds operations that claim to be able to decode the input based on regular * Finds operations that claim to be able to decode the input based on criteria.
* expression matches.
* *
* @returns {Object[]} * @returns {Object[]}
*/ */