From 1db650cdd74aad2b0c32fe5965800ca755a7c0fc Mon Sep 17 00:00:00 2001
From: Harsh Khandeparkar <34770591+HarshKhandeparkar@users.noreply.github.com>
Date: Wed, 1 Jan 2020 22:56:41 +0530
Subject: [PATCH] [GCI] Standardised UI util code comments (#1344)

* standardise comments

* small fix

Co-authored-by: Jeffrey Warren <jeff@unterbahn.com>
---
 examples/lib/insertPreview.js | 7 ++++---
 examples/lib/mapHtmltypes.js  | 6 +++++-
 examples/lib/scopeQuery.js    | 8 ++++++--
 3 files changed, 15 insertions(+), 6 deletions(-)

diff --git a/examples/lib/insertPreview.js b/examples/lib/insertPreview.js
index 32360d95..a34fce15 100644
--- a/examples/lib/insertPreview.js
+++ b/examples/lib/insertPreview.js
@@ -1,3 +1,4 @@
+// Generate downscaled preview images for quick buttons.
 function generatePreview(previewStepName, customValues, path, DomNode) {
   var previewSequencer = ImageSequencer();
   function insertPreview(src) {
@@ -52,8 +53,8 @@ function updatePreviews(src, DomNode) {
     var height = img.height;
     var width = img.width;
 
-    let percentage = (80 / height) * 100; //take the min resize value that fits the preview area => (new-width/orig_ht) - '80 as the preview area has 80*80 dimension
-    percentage = Math.max((80 / width) * 100, percentage); // make sure that one dimension doesn't resize greater, leading distorting preview-area fitting
+    let percentage = (80 / height) * 100; // Take the min resize value that fits the preview area => (new-width/orig_ht) - '80 as the preview area has 80*80 dimension.
+    percentage = Math.max((80 / width) * 100, percentage); // Make sure that one dimension doesn't resize greater, leading distorting preview-area fitting.
     percentage = Math.ceil(percentage);
 
     var sequencer = ImageSequencer();
@@ -74,4 +75,4 @@ function updatePreviews(src, DomNode) {
 module.exports = {
   generatePreview : generatePreview,
   updatePreviews : updatePreviews
-};
+};
\ No newline at end of file
diff --git a/examples/lib/mapHtmltypes.js b/examples/lib/mapHtmltypes.js
index f0cffe09..16899f66 100644
--- a/examples/lib/mapHtmltypes.js
+++ b/examples/lib/mapHtmltypes.js
@@ -1,3 +1,7 @@
+/**
+ * @description Maps module input types to their respective html <input> tag types.
+ * @param {Object} inputInfo Object containing the type and optionally min/max for range type inputs.
+ */
 function mapHtmlTypes(inputInfo){
   var htmlType;
   switch(inputInfo.type.toLowerCase()){
@@ -25,4 +29,4 @@ function mapHtmlTypes(inputInfo){
   return response;
 }
 
-module.exports = mapHtmlTypes;
+module.exports = mapHtmlTypes;
\ No newline at end of file
diff --git a/examples/lib/scopeQuery.js b/examples/lib/scopeQuery.js
index 63b61fcd..d1a503ad 100644
--- a/examples/lib/scopeQuery.js
+++ b/examples/lib/scopeQuery.js
@@ -1,6 +1,7 @@
 /**
  * @method $scope
  * @param {"DOMNode"} scope A DOM Node as the scope
+ * @returns {Function} Constructor for the scopeSelector Object.
  */
 function $scope(scope) {
   return function(queryString){
@@ -24,6 +25,7 @@ function $scope(scope) {
 /**
  * @method $scopeAll
  * @param {"DOMNode"} scope A DOM Node as the scope
+ * @returns {Function} Constructor for the scopeSelectorAll Object.
  */
 function $scopeAll(scope){
   return function(queryString){
@@ -47,7 +49,8 @@ function $scopeAll(scope){
 /**
  * @method scopeSelector
  * @description A scoped jQuery selector
- * @param {"DOMNode"} scope DOM Node as the scope
+ * @param {"DOMNode"} scope A DOM Node as the scope
+ * @returns {Function}
  */
 function scopeSelector(scope){
   return $scope(scope);
@@ -56,7 +59,8 @@ function scopeSelector(scope){
 /**
  * @method scopeSelectorAll
  * @description A scoped jQuery multiple selector
- * @param {"DOMNode} scope DOM Node as the scope
+ * @param {"DOMNode} scope A DOM Node as the scope
+ * @returns {Function}
  */
 function scopeSelectorAll(scope){
   return $scopeAll(scope);