Index: lib/filterClasses.js |
=================================================================== |
--- a/lib/filterClasses.js |
+++ b/lib/filterClasses.js |
@@ -235,17 +235,17 @@ |
/** |
* @see filterToRegExp |
*/ |
Filter.toRegExp = filterToRegExp; |
/** |
* Class for invalid filters |
- * @param {string} text see Filter() |
+ * @param {string} text see {@link Filter Filter()} |
* @param {string} reason Reason why this filter is invalid |
* @constructor |
* @augments Filter |
*/ |
function InvalidFilter(text, reason) |
{ |
Filter.call(this, text); |
@@ -266,17 +266,17 @@ |
* See Filter.serialize() |
* @inheritdoc |
*/ |
serialize(buffer) {} |
}); |
/** |
* Class for comments |
- * @param {string} text see Filter() |
+ * @param {string} text see {@link Filter Filter()} |
* @constructor |
* @augments Filter |
*/ |
function CommentFilter(text) |
{ |
Filter.call(this, text); |
} |
exports.CommentFilter = CommentFilter; |
@@ -289,17 +289,17 @@ |
* @inheritdoc |
*/ |
serialize(buffer) {} |
}); |
/** |
* Abstract base class for filters that can get hits |
* @param {string} text |
- * see Filter() |
+ * see {@link Filter Filter()} |
* @param {string} [domains] |
* Domains that the filter is restricted to separated by domainSeparator |
* e.g. "foo.com|bar.com|~baz.com" |
* @constructor |
* @augments Filter |
*/ |
function ActiveFilter(text, domains) |
{ |
@@ -554,17 +554,17 @@ |
if (this._lastHit) |
buffer.push("lastHit=" + this._lastHit); |
} |
} |
}); |
/** |
* Abstract base class for RegExp-based filters |
- * @param {string} text see Filter() |
+ * @param {string} text see {@link Filter Filter()} |
* @param {string} regexpSource |
* filter part that the regular expression should be build from |
* @param {number} [contentType] |
* Content types the filter applies to, combination of values from |
* RegExpFilter.typeMap |
* @param {boolean} [matchCase] |
* Defines whether the filter should distinguish between lower and upper case |
* letters |
@@ -859,23 +859,23 @@ |
RegExpFilter.typeMap.DOCUMENT | |
RegExpFilter.typeMap.ELEMHIDE | |
RegExpFilter.typeMap.POPUP | |
RegExpFilter.typeMap.GENERICHIDE | |
RegExpFilter.typeMap.GENERICBLOCK); |
/** |
* Class for blocking filters |
- * @param {string} text see Filter() |
- * @param {string} regexpSource see RegExpFilter() |
- * @param {number} [contentType] see RegExpFilter() |
- * @param {boolean} [matchCase] see RegExpFilter() |
- * @param {string} [domains] see RegExpFilter() |
- * @param {boolean} [thirdParty] see RegExpFilter() |
- * @param {string} [sitekeys] see RegExpFilter() |
+ * @param {string} text see {@link Filter Filter()} |
+ * @param {string} regexpSource see {@link RegExpFilter RegExpFilter()} |
+ * @param {number} [contentType] see {@link RegExpFilter RegExpFilter()} |
+ * @param {boolean} [matchCase] see {@link RegExpFilter RegExpFilter()} |
+ * @param {string} [domains] see {@link RegExpFilter RegExpFilter()} |
+ * @param {boolean} [thirdParty] see {@link RegExpFilter RegExpFilter()} |
+ * @param {string} [sitekeys] see {@link RegExpFilter RegExpFilter()} |
* @param {boolean} [collapse] |
* defines whether the filter should collapse blocked content, can be null |
* @param {string} [csp] |
* Content Security Policy to inject when the filter matches |
* @param {?string} [rewrite] |
* The (optional) rule specifying how to rewrite the URL. See |
* BlockingFilter.prototype.rewrite. |
* @constructor |
@@ -939,23 +939,23 @@ |
} |
return url; |
} |
}); |
/** |
* Class for whitelist filters |
- * @param {string} text see Filter() |
- * @param {string} regexpSource see RegExpFilter() |
- * @param {number} [contentType] see RegExpFilter() |
- * @param {boolean} [matchCase] see RegExpFilter() |
- * @param {string} [domains] see RegExpFilter() |
- * @param {boolean} [thirdParty] see RegExpFilter() |
- * @param {string} [sitekeys] see RegExpFilter() |
+ * @param {string} text see {@link Filter Filter()} |
+ * @param {string} regexpSource see {@link RegExpFilter RegExpFilter()} |
+ * @param {number} [contentType] see {@link RegExpFilter RegExpFilter()} |
+ * @param {boolean} [matchCase] see {@link RegExpFilter RegExpFilter()} |
+ * @param {string} [domains] see {@link RegExpFilter RegExpFilter()} |
+ * @param {boolean} [thirdParty] see {@link RegExpFilter RegExpFilter()} |
+ * @param {string} [sitekeys] see {@link RegExpFilter RegExpFilter()} |
* @constructor |
* @augments RegExpFilter |
*/ |
function WhitelistFilter(text, regexpSource, contentType, matchCase, domains, |
thirdParty, sitekeys) |
{ |
RegExpFilter.call(this, text, regexpSource, contentType, matchCase, domains, |
thirdParty, sitekeys); |
@@ -963,17 +963,17 @@ |
exports.WhitelistFilter = WhitelistFilter; |
WhitelistFilter.prototype = extend(RegExpFilter, { |
type: "whitelist" |
}); |
/** |
* Base class for element hiding filters |
- * @param {string} text see Filter() |
+ * @param {string} text see {@link Filter Filter()} |
* @param {string} [domains] Host names or domains the filter should be |
* restricted to |
* @param {string} selector CSS selector for the HTML elements that should be |
* hidden |
* @constructor |
* @augments ActiveFilter |
*/ |
function ElemHideBase(text, domains, selector) |
@@ -1031,55 +1031,55 @@ |
return new ElemHideEmulationFilter(text, domains, selector); |
} |
return new ElemHideFilter(text, domains, selector); |
}; |
/** |
* Class for element hiding filters |
- * @param {string} text see Filter() |
- * @param {string} [domains] see ElemHideBase() |
- * @param {string} selector see ElemHideBase() |
+ * @param {string} text see {@link Filter Filter()} |
+ * @param {string} [domains] see {@link ElemHideBase ElemHideBase()} |
+ * @param {string} selector see {@link ElemHideBase ElemHideBase()} |
* @constructor |
* @augments ElemHideBase |
*/ |
function ElemHideFilter(text, domains, selector) |
{ |
ElemHideBase.call(this, text, domains, selector); |
} |
exports.ElemHideFilter = ElemHideFilter; |
ElemHideFilter.prototype = extend(ElemHideBase, { |
type: "elemhide" |
}); |
/** |
* Class for element hiding exceptions |
- * @param {string} text see Filter() |
- * @param {string} [domains] see ElemHideBase() |
- * @param {string} selector see ElemHideBase() |
+ * @param {string} text see {@link Filter Filter()} |
+ * @param {string} [domains] see {@link ElemHideBase ElemHideBase()} |
+ * @param {string} selector see {@link ElemHideBase ElemHideBase()} |
* @constructor |
* @augments ElemHideBase |
*/ |
function ElemHideException(text, domains, selector) |
{ |
ElemHideBase.call(this, text, domains, selector); |
} |
exports.ElemHideException = ElemHideException; |
ElemHideException.prototype = extend(ElemHideBase, { |
type: "elemhideexception" |
}); |
/** |
* Class for element hiding emulation filters |
- * @param {string} text see Filter() |
- * @param {string} domains see ElemHideBase() |
- * @param {string} selector see ElemHideBase() |
+ * @param {string} text see {@link Filter Filter()} |
+ * @param {string} domains see {@link ElemHideBase ElemHideBase()} |
+ * @param {string} selector see {@link ElemHideBase ElemHideBase()} |
* @constructor |
* @augments ElemHideBase |
*/ |
function ElemHideEmulationFilter(text, domains, selector) |
{ |
ElemHideBase.call(this, text, domains, selector); |
} |
exports.ElemHideEmulationFilter = ElemHideEmulationFilter; |