Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Unified Diff: lib/filterValidation.js

Issue 4886747309670400: Noissue - Added documentation for exported functions to the "filterValidation" module (Closed)
Patch Set: Addressed comments Created March 3, 2015, 9:07 a.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: lib/filterValidation.js
===================================================================
--- a/lib/filterValidation.js
+++ b/lib/filterValidation.js
@@ -17,6 +17,17 @@
let {Filter, InvalidFilter, ElemHideBase} = require("filterClasses");
+/**
+ * Parses and validates a filter given by the user.
+ *
+ * @param {string} text
+ * @param {Boolean} [ignore_headers=false] If true, no exception is raised
+ * for filter list headers, instead
+ * the function will return null.
+ * @return {Filter}
+ * @throws Will throw an exception if filter cannot be
+ * parsed or contains an invalid CSS selector.
+ */
function parseFilter(text, ignore_headers)
{
text = Filter.normalize(text);
@@ -58,6 +69,17 @@
}
exports.parseFilter = parseFilter;
+/**
+ * Parses and validates a newline-separated list of filters given by the user.
+ *
+ * @param {string} text
+ * @param {Boolean} [ignore_headers=false] If true, filter list headers
+ * will be stripped instead of
+ * raising an exception.
+ * @return {Filter[]}
+ * @throws Will throw an exception if one of the filters cannot
+ be parsed or contains an invalid CSS selector.
+ */
function parseFilters(text, ignore_headers)
{
let lines = text.split("\n");
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld