JSDoc Linting

iota-pico · Apr 26, 2018 · b158547 · b158547
1 parent 88851ef
commit b158547
Show file tree

Hide file tree

Showing 50 changed files with 289 additions and 238 deletions.
diff --git a/coverage/lcov-report/index.html b/coverage/lcov-report/index.html
@@ -116,7 +116,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="prettify.js"></script>

diff --git a/coverage/lcov-report/src/index.html b/coverage/lcov-report/src/index.html
@@ -77,7 +77,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../prettify.js"></script>

diff --git a/coverage/lcov-report/src/pearlDiver/index.html b/coverage/lcov-report/src/pearlDiver/index.html
@@ -90,7 +90,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/pearlDiver/pearlDiver.ts.html b/coverage/lcov-report/src/pearlDiver/pearlDiver.ts.html
@@ -288,7 +288,8 @@ <h1>
 243
 244
 245
-246</td><td class="line-coverage quiet"><span class="cline-any cline-yes">1×</span>
+246
+247</td><td class="line-coverage quiet"><span class="cline-any cline-yes">1×</span>
 <span class="cline-any cline-yes">1×</span>
 <span class="cline-any cline-yes">1×</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -385,6 +386,7 @@ <h1>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">16×</span>
 <span class="cline-any cline-yes">15×</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -628,6 +630,7 @@ <h1>
 &nbsp;
     /**
      * Initialize the PearlDiver main instance.
+     * @param webGLPlatform The platform so initialize the pearl diver with.
      */
     public static initialize(webGLPlatform: IWebGLPlatform): void {
         if (!PearlDiver.instance) {
@@ -784,7 +787,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/pearlDiver/pearlDiverState.ts.html b/coverage/lcov-report/src/pearlDiver/pearlDiverState.ts.html
@@ -73,7 +73,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/proofOfWorkWebGl.ts.html b/coverage/lcov-report/src/proofOfWorkWebGl.ts.html
@@ -128,7 +128,8 @@ <h1>
 83
 84
 85
-86</td><td class="line-coverage quiet"><span class="cline-any cline-yes">1×</span>
+86
+87</td><td class="line-coverage quiet"><span class="cline-any cline-yes">1×</span>
 <span class="cline-any cline-yes">1×</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">1×</span>
@@ -177,6 +178,7 @@ <h1>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">16×</span>
 <span class="cline-any cline-yes">16×</span>
 <span class="cline-any cline-yes">16×</span>
@@ -260,6 +262,7 @@ <h1>
     /**
      * Allow the proof of work to perform any initialization.
      * Will throw an exception if the implementation is not supported.
+     * @returns Promise.
      */
     public async initialize(): Promise&lt;void&gt; {
         await super.initialize();
@@ -304,7 +307,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../prettify.js"></script>

diff --git a/coverage/lcov-report/src/shaders/add.ts.html b/coverage/lcov-report/src/shaders/add.ts.html
@@ -229,7 +229,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/shaders/checkCol.ts.html b/coverage/lcov-report/src/shaders/checkCol.ts.html
@@ -127,7 +127,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/shaders/checkDo.ts.html b/coverage/lcov-report/src/shaders/checkDo.ts.html
@@ -97,7 +97,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/shaders/checkK.ts.html b/coverage/lcov-report/src/shaders/checkK.ts.html
@@ -94,7 +94,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/shaders/finalize.ts.html b/coverage/lcov-report/src/shaders/finalize.ts.html
@@ -109,7 +109,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/shaders/headers.ts.html b/coverage/lcov-report/src/shaders/headers.ts.html
@@ -85,7 +85,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/shaders/increment.ts.html b/coverage/lcov-report/src/shaders/increment.ts.html
@@ -100,7 +100,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/shaders/index.html b/coverage/lcov-report/src/shaders/index.html
@@ -181,7 +181,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/shaders/init.ts.html b/coverage/lcov-report/src/shaders/init.ts.html
@@ -106,7 +106,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/shaders/transform.ts.html b/coverage/lcov-report/src/shaders/transform.ts.html
@@ -127,7 +127,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/webGL/index.html b/coverage/lcov-report/src/webGL/index.html
@@ -116,7 +116,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/webGL/stdlib.ts.html b/coverage/lcov-report/src/webGL/stdlib.ts.html
@@ -151,7 +151,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/webGL/vertexShaderCode.ts.html b/coverage/lcov-report/src/webGL/vertexShaderCode.ts.html
@@ -88,7 +88,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/webGL/webGLHelper.ts.html b/coverage/lcov-report/src/webGL/webGLHelper.ts.html
@@ -141,7 +141,8 @@ <h1>
 96
 97
 98
-99</td><td class="line-coverage quiet"><span class="cline-any cline-yes">1×</span>
+99
+100</td><td class="line-coverage quiet"><span class="cline-any cline-yes">1×</span>
 <span class="cline-any cline-yes">1×</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -155,6 +156,7 @@ <h1>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">15×</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">15×</span>
@@ -250,6 +252,7 @@ <h1>
 export class WebGLHelper {
     /**
      * Create a WebGL Context.
+     * @param webGLPlatform The platform to create the context with.
      * @returns The context if successfuly or throws an error if it cannot be created.
      */
     public static createContext(webGLPlatform: IWebGLPlatform): WebGLRenderingContextExt {
@@ -343,7 +346,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>

diff --git a/coverage/lcov-report/src/webGL/webGLWorker.ts.html b/coverage/lcov-report/src/webGL/webGLWorker.ts.html
@@ -284,7 +284,8 @@ <h1>
 239
 240
 241
-242</td><td class="line-coverage quiet"><span class="cline-any cline-yes">1×</span>
+242
+243</td><td class="line-coverage quiet"><span class="cline-any cline-yes">1×</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">1×</span>
 <span class="cline-any cline-yes">1×</span>
@@ -447,6 +448,7 @@ <h1>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">11×</span>
 <span class="cline-any cline-yes">11×</span>
 <span class="cline-any cline-yes">11×</span>
@@ -686,6 +688,7 @@ <h1>
      * @param y The y position to read from.
      * @param n The width position to read from.
      * @param m The height position to read from.
+     * @returns The data at the requested position.
      */
     public readData(x: number, y: number, n: number, m: number): Int32Array {
         this._context.bindFramebuffer(this._context.FRAMEBUFFER, this._frameBuffer);
@@ -772,7 +775,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 24 2018 16:33:48 GMT+0300 (E. Africa Standard Time)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Apr 26 2018 17:48:17 GMT+0300 (E. Africa Standard Time)
 </div>
 </div>
 <script src="../../prettify.js"></script>