aboutsummaryrefslogtreecommitdiff
path: root/ext/js/dom
diff options
context:
space:
mode:
authortoasted-nutbread <toasted-nutbread@users.noreply.github.com>2023-12-15 20:31:48 -0500
committerGitHub <noreply@github.com>2023-12-16 01:31:48 +0000
commitc312e7a55114b913afcd85d92f2bf1006b8af246 (patch)
tree431428468ae5e2f643ee0036b6504fba4757c7df /ext/js/dom
parent730b34c0bbe394fd62afb20b32152139a65b0b60 (diff)
Fix usage of any (*) type in DocumentUtil (#361)
Diffstat (limited to 'ext/js/dom')
-rw-r--r--ext/js/dom/document-util.js19
1 files changed, 3 insertions, 16 deletions
diff --git a/ext/js/dom/document-util.js b/ext/js/dom/document-util.js
index b2aa8f81..0153e74a 100644
--- a/ext/js/dom/document-util.js
+++ b/ext/js/dom/document-util.js
@@ -100,22 +100,9 @@ export class DocumentUtil {
* @param {boolean} layoutAwareScan Whether or not layout-aware scan mode should be used.
* @param {number} extent The length of the sentence to extract.
* @param {boolean} terminateAtNewlines Whether or not a sentence should be terminated at newline characters.
- * @param {Map<string, *[]>} terminatorMap A mapping of characters that terminate a sentence.
- * Format:
- * ```js
- * new Map([ [character: string, [includeCharacterAtStart: boolean, includeCharacterAtEnd: boolean]], ... ])
- * ```
- * @param {Map<string, *[]>} forwardQuoteMap A mapping of quote characters that delimit a sentence.
- * Format:
- * ```js
- * new Map([ [character: string, [otherCharacter: string, includeCharacterAtStart: boolean]], ... ])
- * ```
- * @param {Map<string, *[]>} backwardQuoteMap A mapping of quote characters that delimit a sentence,
- * which is the inverse of forwardQuoteMap.
- * Format:
- * ```js
- * new Map([ [character: string, [otherCharacter: string, includeCharacterAtEnd: boolean]], ... ])
- * ```
+ * @param {import('text-scanner').SentenceTerminatorMap} terminatorMap A mapping of characters that terminate a sentence.
+ * @param {import('text-scanner').SentenceForwardQuoteMap} forwardQuoteMap A mapping of quote characters that delimit a sentence.
+ * @param {import('text-scanner').SentenceBackwardQuoteMap} backwardQuoteMap A mapping of quote characters that delimit a sentence, which is the inverse of forwardQuoteMap.
* @returns {{text: string, offset: number}} The sentence and the offset to the original source.
*/
static extractSentence(source, layoutAwareScan, extent, terminateAtNewlines, terminatorMap, forwardQuoteMap, backwardQuoteMap) {