diff options
Diffstat (limited to 'ext/js/dom/document-util.js')
| -rw-r--r-- | ext/js/dom/document-util.js | 19 |
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) { |