summaryrefslogtreecommitdiff
path: root/dev
diff options
context:
space:
mode:
authorCashew <52880648+Scrub1492@users.noreply.github.com>2023-12-19 14:22:22 +0900
committerGitHub <noreply@github.com>2023-12-19 05:22:22 +0000
commit5f96276fda93dcad39f2165fd3c8d890aa5f9be5 (patch)
tree1437c9298afa0ecd41414446043fe799026e8c79 /dev
parent7b93055f2e3d79729195fbd515cdccbf538c9376 (diff)
update JSDoc comments (#387)
* lesen-tan initial commit * update README.md * tidy up code * opt for Map<K, V> instead of Object * Document dev/* * add docs for deinflector.js * update deinflector example * Annotate * Revert "Merge branch 'development' of https://github.com/Scrub1492/lesen-tan into development" This reverts commit b92348f702bc031b36f24462adfa940d17f9ecdd, reversing changes made to 3255e6d963281af3533dcf1e893df39032d29fec. * Lint error fix * Lint error fix * update JSDoc comments --------- Co-authored-by: Darius Jahandarie <djahandarie@gmail.com>
Diffstat (limited to 'dev')
-rw-r--r--dev/dictionary-validate.js12
1 files changed, 6 insertions, 6 deletions
diff --git a/dev/dictionary-validate.js b/dev/dictionary-validate.js
index 6778f2ea..7842c65e 100644
--- a/dev/dictionary-validate.js
+++ b/dev/dictionary-validate.js
@@ -71,10 +71,10 @@ async function validateDictionaryBanks(mode, zip, fileNameFormat, schema) {
}
/**
- * Validates a dictionary.
- * @param {import('dev/schema-validate').ValidateMode} mode Mode of validation.
- * @param {import('jszip')} archive Zip archive of the dictionary.
- * @param {import('dev/dictionary-validate').Schemas} schemas Schema to use for validation.
+ * Validates a dictionary from its zip archive.
+ * @param {import('dev/schema-validate').ValidateMode} mode
+ * @param {import('jszip')} archive
+ * @param {import('dev/dictionary-validate').Schemas} schemas
*/
export async function validateDictionary(mode, archive, schemas) {
const fileName = 'index.json';
@@ -121,8 +121,8 @@ export function getSchemas() {
/**
* Validates dictionary files and logs the results to the console.
- * @param {import('dev/schema-validate').ValidateMode} mode Mode of validation.
- * @param {string[]} dictionaryFileNames Dictionary file names.
+ * @param {import('dev/schema-validate').ValidateMode} mode
+ * @param {string[]} dictionaryFileNames
*/
export async function testDictionaryFiles(mode, dictionaryFileNames) {
const schemas = getSchemas();