Improve jsdoc

This commit is contained in:
Daniel Imms
2017-02-14 19:45:22 -08:00
parent 5183332f6e
commit 3b62aa444b
2 changed files with 10 additions and 8 deletions
+1 -1
View File
@@ -74,7 +74,7 @@ export class Linkifier {
/**
* Registers a link matcher, allowing custom link patterns to be matched and
* handled.
* @param {RegExp} regex The regular expression the search for, specifically
* @param {RegExp} regex The regular expression to search for, specifically
* this searches the textContent of the rows. You will want to use \s to match
* a space ' ' character for example.
* @param {LinkHandler} handler The callback when the link is called.
+9 -7
View File
@@ -1299,13 +1299,15 @@ Terminal.prototype.attachHypertextLinkHandler = function(handler) {
/**
* Registers a link matcher, allowing custom link patterns to be matched and
* handled.
* @param {RegExp} regex The regular expression the search for.
* @param {LinkHandler} handler The callback when the link is called.
* @param {number} matchIndex The index of the link from the regex.match(html)
* call. This defaults to 0 (for regular expressions without capture groups).
* @return {number} The ID of the new matcher, this can be used to deregister.
* Registers a link matcher, allowing custom link patterns to be matched and
* handled.
* @param {RegExp} regex The regular expression to search for, specifically
* this searches the textContent of the rows. You will want to use \s to match
* a space ' ' character for example.
* @param {LinkHandler} handler The callback when the link is called.
* @param {number} matchIndex The index of the link from the regex.match(html)
* call. This defaults to 0 (for regular expressions without capture groups).
* @return {number} The ID of the new matcher, this can be used to deregister.
*/
Terminal.prototype.registerLinkMatcher = function(regex, handler, matchIndex) {
if (this.linkifier) {