From a221a3c9f87ef51018664d3a3044562147b84c0c Mon Sep 17 00:00:00 2001 From: TDaglis Date: Thu, 22 Oct 2015 09:53:14 +0300 Subject: [PATCH] documented lenient option of linkify --- addons/linkify/linkify.js | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/addons/linkify/linkify.js b/addons/linkify/linkify.js index 61cadb99..9834183b 100644 --- a/addons/linkify/linkify.js +++ b/addons/linkify/linkify.js @@ -46,6 +46,8 @@ * @param {Xterm} terminal - The terminal that owns the given line. * @param {number|HTMLDivElement} line - The terminal line that should get * "linkified". + * @param {boolean} lenient - The regex type that will be used to identify links. If lenient is + * false, the regex requires a protocol clause. Defaults to true. * @emits linkify * @emits linkify:line */ @@ -122,6 +124,8 @@ * Converts all valid URLs found in the terminal view into hyperlinks. * * @param {Xterm} terminal - The terminal that should get "linkified". + * @param {boolean} lenient - The regex type that will be used to identify links. If lenient is + * false, the regex requires a protocol clause. Defaults to true. * @emits linkify * @emits linkify:line */ @@ -156,6 +160,8 @@ * @memberof Xterm * @param {number|HTMLDivElement} line - The terminal line that should get * "linkified". + * @param {boolean} lenient - The regex type that will be used to identify links. If lenient is + * false, the regex requires a protocol clause. Defaults to true. */ Xterm.prototype.linkifyTerminalLine = function (line, lenient) { return exports.linkifyTerminalLine(this, line, lenient); @@ -165,6 +171,8 @@ * Converts all valid URLs found in the current terminal into hyperlinks. * * @memberof Xterm + * @param {boolean} lenient - The regex type that will be used to identify links. If lenient is + * false, the regex requires a protocol clause. Defaults to true. */ Xterm.prototype.linkify = function (lenient) { return exports.linkify(this, lenient);