modules_tests: comments + minor edits

Author: amroamroamro

tests/extractSourceSpans_test.html

@@ -60,31 +60,40 @@ <h1>Extract Source Spans Test</h1>
   var testInputs = Array.prototype.slice.call(
     document.getElementsByClassName('testinput'), 0);
   for (var i = 0, n = testInputs.length; i < n; ++i) {
+    // td.input > .testinput
     var testInput = testInputs[i];
+    // td.golden
     var testResult = testInput.parentNode.nextSibling;
     while (testResult.nodeType !== 1) { testResult = testResult.nextSibling; }
+    // td.actual
     var actual = document.createElement('TD');
     actual.className = 'actual';
     testResult.parentNode.appendChild(actual);
     try {
+      // run function
       var isPreformatted = /pre|xmp/i.test(testInput.tagName);
       var sourceAndSpans = extractSourceSpans(testInput, isPreformatted);
+      // build result
       var source = sourceAndSpans.sourceCode;
       var spans = sourceAndSpans.spans;
       var actualText = '^';
       var actualHtml = '';
       for (var j = 0, m = spans.length; j < m; j += 2) {
+        // extract span text
         var start = spans[j], end = spans[j + 2] || source.length;
         var span = source.substring(start, end);
         actualText += span + '^';
+        // determine span class name
         var spanClass = ((j & 2) ? 'odd' : 'even');
         if (spans[j + 1].nodeName === 'BR') {
           spanClass += ' break';
         }
+        // html formatted
         actualHtml += '<span class="' + spanClass+ '">' +
           span.replace(/&/g, '&amp;').replace(/</g, '&lt;') + '<\/span>';
       }
       actual.innerHTML = '<pre>' + actualHtml + '<\/pre>';
+      // compare result against expected
       var goldenText = testResult.innerText || testResult.textContent;
       var goldenNormalized = '"' + goldenText.replace(/(?:\r\n?|\n)$/, '') + '"';
       var actualNormalized = stringify(actualText);

tests/numberLines_test.html

@@ -65,25 +65,31 @@ <h1>Number Lines Test</h1>
   var testInputs = Array.prototype.slice.call(
     document.getElementsByClassName('testinput'), 0);
   for (var i = 0, n = testInputs.length; i < n; ++i) {
+    // td.input > .testinput
     var testInput = testInputs[i];
+    // td.golden
     var testResult = testInput.parentNode.nextSibling;
     while (testResult.nodeType !== 1) { testResult = testResult.nextSibling; }
+    // td.actual
     var actual = document.createElement('TD');
     testResult.parentNode.appendChild(actual);
     try {
-      var testInputClone = testInput.cloneNode(true);
-      testInputClone.className = '';  // IE
-      testInputClone.removeAttribute('class');  // Not IE.
-      actual.appendChild(testInputClone);
+      // make a copy of input node (modified in-place)
+      var clone = testInput.cloneNode(true);
+      clone.className = '';  // IE
+      clone.removeAttribute('class');  // Not IE.
+      actual.appendChild(clone);
+      // run function
       var startLineNum = true;
-      var isPreformatted = /pre|xmp/i.test(testInputClone.tagName);
-      numberLines(testInputClone, startLineNum, isPreformatted);
-      var goldenNorm = normListItems(testResult.innerHTML);
-      var actualNorm = normListItems(actual.innerHTML);
-      var passed = goldenNorm === actualNorm;
+      var isPreformatted = /pre|xmp/i.test(clone.tagName);
+      numberLines(clone, startLineNum, isPreformatted);
+      // compare result again expected
+      var goldenNormalized = normListItems(testResult.innerHTML);
+      var actualNormalized = normListItems(actual.innerHTML);
+      var passed = goldenNormalized === actualNormalized;
       if (!passed) {
-        console.log(JSON.stringify(goldenNorm) + '\n!==\n' +
-          JSON.stringify(actualNorm));
+        console.log(JSON.stringify(goldenNormalized) + '\n!==\n' +
+          JSON.stringify(actualNormalized));
       }
       actual.className = passed ? 'ok' : 'failure';
     } catch (ex) {

tests/recombineTagsAndDecorations_test.html

@@ -40,22 +40,29 @@ <h1>Recombine Tags And Decorations Test</h1>
   var testInputs = Array.prototype.slice.call(
     document.getElementsByClassName('testinput'), 0);
   for (var i = 0, n = testInputs.length; i < n; ++i) {
+    // td.input > .testinput
     var testInput = testInputs[i];
+    // td.decorations (result of language handler function)
     var decorationsNode = testInput.parentNode.nextSibling;
     while (decorationsNode.nodeType !== 1) { decorationsNode = decorationsNode.nextSibling; }
+    // td.golden
     var testResult = decorationsNode.nextSibling;
     while (testResult.nodeType !== 1) { testResult = testResult.nextSibling; }
+    // td.actual
     var actual = document.createElement('TD');
     testResult.parentNode.appendChild(actual);
+    // make a copy of input node (modified in-place)
     var clone = testInput.cloneNode(true);
     clone.className = '';  // IE
     clone.removeAttribute('class');  // Not IE.
     actual.appendChild(clone);
+    // run function
     var isPreformatted = /pre|xmp/i.test(clone.tagName);
     var job = extractSourceSpans(clone, isPreformatted);
     job.decorations = eval(decorationsNode.innerText || decorationsNode.textContent);
     try {
       recombineTagsAndDecorations(job);
+      // compare result against expected
       var passed = testResult.innerHTML === actual.innerHTML;
       if (!passed) {
         console.log(JSON.stringify(testResult.innerHTML) + '\n!==\n' +