Revize 6c9cb54a

Re #8475 - Added code comments

static/js/utilities.js

@@ +1 @@
+/**
+ * Generate a file to be downloaded by the browser
+ * @param filename name of the file to be downloaded
+ * @param text content of the downloaded file
+ */
 function download(filename, text) {
-  var element = document.createElement('a');
-  element.setAttribute('href', 'data:text/plain;charset=utf-8,' + encodeURIComponent(text));
-  element.setAttribute('download', filename);
+    // first a hidden <a> element is created and download content is assigned
+    var element = document.createElement('a');
+    element.setAttribute('href', 'data:text/plain;charset=utf-8,' + encodeURIComponent(text));
+    element.setAttribute('download', filename);
 
-  element.style.display = 'none';
-  document.body.appendChild(element);
+    element.style.display = 'none';
+    document.body.appendChild(element);
 
-  element.click();
+    // generate artificial click event to download the file
+    element.click();
 
-  document.body.removeChild(element);
+    // remove the download link from the webpage
+    document.body.removeChild(element);
 }
 
+// Adds toDateInputValue() method to Date object
+// toDateInputValue() produces date in YYYY-MM-DD format
 Date.prototype.toDateInputValue = (function() {
     var local = new Date(this);
     local.setMinutes(this.getMinutes() - this.getTimezoneOffset());