summaryrefslogtreecommitdiff
path: root/ext/js/language/translator.js
diff options
context:
space:
mode:
authortoasted-nutbread <toasted-nutbread@users.noreply.github.com>2022-05-20 10:28:38 -0400
committerGitHub <noreply@github.com>2022-05-20 10:28:38 -0400
commit31e20c889e467aa4ba64b0b5baf602adc1359371 (patch)
treea033db935a817b2d407ec20843176610a87a6e16 /ext/js/language/translator.js
parentae0ad227c0fd293609a21e5cc1d2a4b85fe7c520 (diff)
ESlint JSdoc (#2148)
* Install eslint-plugin-jsdoc * Initial rules setup * Update lists * Use @returns rather than @return * Remove error throwing code which is never executed * Fix issues relating to @throws * General error fixes * Update Display type documentation * Various doc fixes * Fix invalid tuple syntax * Doc updates * Remove unused * Doc updates * Enable jsdoc/require-returns * Update rules * Update remaining rules
Diffstat (limited to 'ext/js/language/translator.js')
-rw-r--r--ext/js/language/translator.js10
1 files changed, 10 insertions, 0 deletions
diff --git a/ext/js/language/translator.js b/ext/js/language/translator.js
index fafd1bfb..73f27ff9 100644
--- a/ext/js/language/translator.js
+++ b/ext/js/language/translator.js
@@ -26,6 +26,16 @@
*/
class Translator {
/**
+ * Information about how popup content should be shown, specifically related to the outer popup frame.
+ * @typedef {object} TermFrequency
+ * @property {string} term The term.
+ * @property {string} reading The reading of the term.
+ * @property {string} dictionary The name of the dictionary that the term frequency originates from.
+ * @property {boolean} hasReading Whether or not a reading was specified.
+ * @property {number|string} frequency The frequency value for the term.
+ */
+
+ /**
* Creates a new Translator instance.
* @param {object} details The details for the class.
* @param {JapaneseUtil} details.japaneseUtil An instance of JapaneseUtil.