Comments and TODO added

mobiniusHarshajagadish · mobiniusHarshajagadish · commit 7fb718c629b8 · 2015-12-09T18:25:50.000+05:30
diff --git a/js/jquery.speedtest.js b/js/jquery.speedtest.js
@@ -1,5 +1,9 @@
 
 (function($) {
+    // A simple speedtest plugin to check download speed in a network.
+    //Author : Harsha Jagadish
+    //Version : V 0.1
+    // TODO: Add waiting message and waiting image
     $.fn._speedTest = function(options) {
 
         function foo(){
@@ -13,7 +17,7 @@
                 }, options),
                 duration, download, startTime, endTime, bitsLoaded,cacheBuster,speedMbps,speedKbps,speedBps,p;
 
-
+                // TODO: add more types to handle for download
                 if (stest.fileType == "text") {
                     download = new Document();
                 } else if (stest.fileType == "image") {
@@ -30,6 +34,7 @@
                 cacheBuster = "?spdt=" + startTime;
                 download.src = stest.fileUrl + cacheBuster;
                  p = function see(){
+                    // TODO: change the calculation to handle the error managment
                    endTime = (new Date()).getTime();
                    duration = (endTime - startTime) / 1000;
                    bitsLoaded = stest.fileSize * 8;
@@ -46,8 +51,10 @@
 
 
         return this.each(function() {
+            //TODO: remove too many variable names
             var g = foo();
-            $(this).text(g);
+            // TODO: make the speed extension as a variable to fit user needs
+            $(this).text(g).append("&nbsp; Mbps");
         }); //end of for each function
 
     }; //end of the main function
diff --git a/js/jquery.speedtest.min.js b/js/jquery.speedtest.min.js
diff --git a/speedTest.html b/speedTest.html
@@ -1,4 +1,9 @@
 <!DOCTYPE html>
+<!-- A sample HTML file to have call the speedtest plugin
+** Author: Harsha Jagadish
+**Website:www.harshajagadish.com
+**
+-->
 <html lang="en">
   <head>
     <meta charset="utf-8">
@@ -13,17 +18,32 @@
       <script src="https://cdn.jsdelivr.net/html5shiv/3.7.2/html5shiv.min.js"></script>
       <script src="https://cdn.jsdelivr.net/respond/1.4.2/respond.min.js"></script>
     <![endif]-->
+    <style>
+      .speed_container{
+        margin:5% 0 0 25%;
+      }
+    </style>
   </head>
   <body>
-    <h2 id="t">should display here if no error </h2>
-    <p></p>
+    <div class="container">
+      <div class="col-sm-5 text-center speed_container">
+        <div class="panel panel-default">
+          <div class="panel-heading text-center">
+            <h1 class="panel-title">Network Speed</h1>
+          </div>
+          <div class="panel-body text-center">
+              <h3></h3>
+          </div>
+        </div>
+      </div>
+  </div>
     <script src="https://cdn.jsdelivr.net/jquery/2.1.3/jquery.min.js"></script>
     <script src="https://cdn.jsdelivr.net/bootstrap/3.3.5/js/bootstrap.min.js"></script>
     <script src="js/jquery.speedtest.js"></script>
     <script>
-      $('p')._speedTest({
-        fileSize:12800,
-        fileType:"image",
+      $('h3')._speedTest({
+         fileSize:1280, //size of the file in bytes
+        fileType:"image",//type of the file to be downloaded
         fileUrl:"http://mobinius.com/wp-content/uploads/2012/02/silicon-India.png"
       });
     </script>
