Noissue - Added documentation for exported functions to the "filterValidation" module

lib/filterValidation.js

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,
+ *                                          but null is returned instead,
+ *                                          if a filter list header is given.

[Wladimir Palant, 2015/03/02 20:45:15]

I have a hard time parsing that sentence :)

How about: "If true, no exception is raised for filter list headers, instead the
function will return null."

[Sebastian Noack, 2015/03/03 09:07:48]

Done.

+ * @return {Filter}
+ * @throws Will throw an error if filter cannot be parsed

[Wladimir Palant, 2015/03/02 20:45:15]

Nit: "throw an exception"?

[Sebastian Noack, 2015/03/03 09:07:48]

Done.

+ *         or contains an invalid CSS selector.
+ */
 function parseFilter(text, ignore_headers)
 {
   text = Filter.normalize(text);
@@ -58,6 +69,16 @@
 }
 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 are stripped.

[Wladimir Palant, 2015/03/02 20:45:15]

"If true, filter list headers will be stripped instead of raising an exception"?

[Sebastian Noack, 2015/03/03 09:07:48]

Done.

+ * @return {Filter[]}
+ * @throws Will throw an error if one of the filters cannot
+           be parsed or contains an invalid CSS selector.
+ */
 function parseFilters(text, ignore_headers)
 {
   let lines = text.split("\n");