Small nomenclature changes.

DarkDrim · Jun 8, 2020 · 59554ba · 59554ba
1 parent c4e5501
commit 59554ba
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 15 deletions.
diff --git a/test_report.js b/test_report.js
@@ -39,7 +39,7 @@ class GoTestReportElements {}
 
 
 /**
- *
+ * Main entry point for GoTestReport.
  * @param {GoTestReportElements} elements
  * @returns {{testResultsClickHandler: testResultsClickHandler}}
  * @constructor
@@ -60,9 +60,9 @@ window.GoTestReport = function (elements) {
 
   const goTestReport = {
     /**
-     *
-     * @param {HTMLElement} target
-     * @param {boolean} shiftKey
+     * Invoked when a user clicks on one of the test group div elements.
+     * @param {HTMLElement} target The element associated with the test group.
+     * @param {boolean} shiftKey If pressed, all of test detail associated to the test group is shown.
      * @param {TestResults} data
      * @param {SelectedItems} selectedItems
      * @param {function(target: Element, data: TestResults)} testGroupListHandler
@@ -73,8 +73,8 @@ window.GoTestReport = function (elements) {
                                        selectedItems,
                                        testGroupListHandler) {
       if (selectedItems.testResults != null) {
-        let f = /**@type {HTMLElement}*/ selectedItems.testResults
-        f.style.backgroundColor = selectedItems.selectedTestGroupColor
+        let testResultsElement = /**@type {HTMLElement}*/ selectedItems.testResults
+        testResultsElement.style.backgroundColor = selectedItems.selectedTestGroupColor
       }
       const testGroupId = /**@type {number}*/ target.id
       const testResults = /**@type {TestResults}*/ data[testGroupId]['TestResults']
@@ -151,18 +151,21 @@ window.GoTestReport = function (elements) {
     }
   }
 
+  //+------------------------+
+  //|    setup DOM events    |
+  //+------------------------+
   elements.testResultsElem
           .addEventListener('click', event =>
             goTestReport.testResultsClickHandler(/**@type {HTMLElement}*/ addEventData(event).data.target,
-                                           event.shiftKey,
-                                           elements.data,
-                                           selectedItems,
-                                           goTestReport.testGroupListHandler))
+                                                 event.shiftKey,
+                                                 elements.data,
+                                                 selectedItems,
+                                                 goTestReport.testGroupListHandler))
 
   elements.testGroupListElem
           .addEventListener('click', event =>
             goTestReport.testGroupListHandler(/**@type {Element}*/ event.target,
-                                        elements.data))
+                                              elements.data))
 
   return goTestReport
 }
diff --git a/test_report.test.js b/test_report.test.js
@@ -100,12 +100,12 @@ test('test GoTestReport constructor with click event on a test group', () => {
 
 
 /**
- *
+ * Returns an element using the provided testGroupId and testIndex.
  * @param {number} testGroupId
  * @param {number} testIndex
  * @returns {HTMLDivElement}
  */
-function foobar(testGroupId, testIndex) {
+function createDataGroupElement(testGroupId, testIndex) {
   const divElem = document.createElement('div')
   const testGroupIdAttr = document.createAttribute('data-groupid')
   testGroupIdAttr.value = testGroupId.toString()
@@ -118,7 +118,7 @@ function foobar(testGroupId, testIndex) {
 
 test('test testGroupListHandler using [test group: 0]', () => {
   const goTestReport = new window.GoTestReport(createTestElements());
-  let divElem = foobar(0, 0)
+  let divElem = createDataGroupElement(0, 0)
   goTestReport.testGroupListHandler(divElem, mockData)
   const testOutputDiv = divElem.querySelector('div.testOutput')
   const consoleElem = testOutputDiv.querySelector('.console.failed')
@@ -132,7 +132,7 @@ test('test testGroupListHandler using [test group: 0]', () => {
 
 test('test testGroupListHandler using [test group: 1]', () => {
   const goTestReport = new window.GoTestReport(createTestElements());
-  let divElem = foobar(2, 0)
+  let divElem = createDataGroupElement(2, 0)
   goTestReport.testGroupListHandler(divElem, mockData)
   const testOutputDiv = divElem.querySelector('div.testOutput')
   const consoleElem = testOutputDiv.querySelector('.console')