Generated documentation

cse210-works-on-my-machine · Dec 13, 2023 · bb724e1 · bb724e1
1 parent 64b0ada
commit bb724e1
Show file tree

Hide file tree

Showing 16 changed files with 19 additions and 48 deletions.
diff --git a/docs/Display.html b/docs/Display.html
@@ -121,7 +121,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/Fetcher.html b/docs/Fetcher.html
@@ -121,7 +121,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/InstanceEntry.html b/docs/InstanceEntry.html
@@ -168,7 +168,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/Paginator_Paginator.html b/docs/Paginator_Paginator.html
@@ -229,7 +229,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/entity_InstanceEntry.js.html b/docs/entity_InstanceEntry.js.html
@@ -84,10 +84,6 @@ <h1 class="page-title">Source: entity/InstanceEntry.js</h1>
         script.type = "module";
         script.textContent = `
         import { handleRemoveInstance } from './src/scripts/instanceList.js';
-        // document.getElementById('instance-removal-button').addEventListener('click', () => {
-        //     handleRemoveInstance(${this.network}, ${this.url});
-        //     console.log('removal button clicked');
-        // });
         window.handleRemoveInstance = handleRemoveInstance;
         `;
         this.shadowRoot.appendChild(script);
@@ -111,7 +107,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/fetchers_Fetcher.js.html b/docs/fetchers_Fetcher.js.html
@@ -54,7 +54,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/fetchers_LemmyFetcher.js.html b/docs/fetchers_LemmyFetcher.js.html
@@ -73,7 +73,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/fetchers_MastodonFetcher.js.html b/docs/fetchers_MastodonFetcher.js.html
@@ -108,7 +108,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/global.html b/docs/global.html
@@ -661,7 +661,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="instanceList.js.html">instanceList.js</a>, <a href="instanceList.js.html#line69">line 69</a>
+        <a href="instanceList.js.html">instanceList.js</a>, <a href="instanceList.js.html#line61">line 61</a>
     </li></ul></dd>
 
 
@@ -844,7 +844,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="instanceList.js.html">instanceList.js</a>, <a href="instanceList.js.html#line85">line 85</a>
+        <a href="instanceList.js.html">instanceList.js</a>, <a href="instanceList.js.html#line77">line 77</a>
     </li></ul></dd>
 
 
@@ -1296,7 +1296,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="instanceList.js.html">instanceList.js</a>, <a href="instanceList.js.html#line100">line 100</a>
+        <a href="instanceList.js.html">instanceList.js</a>, <a href="instanceList.js.html#line92">line 92</a>
     </li></ul></dd>
 
 
@@ -1370,7 +1370,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/instanceList.js.html b/docs/instanceList.js.html
@@ -71,15 +71,7 @@ <h1 class="page-title">Source: instanceList.js</h1>
  * @returns {Promise&lt;boolean>} Promise which resolves to True if the instance addition was successful, False otherwise
  */
 export async function addInstance(network, url, storage = localStorage) {
-    // TODO: move validation out of this function? (may separate concerns better)
     if (!(ALLOWED_NETWORKS.has(network)) || !validUrl(url)) return false;
-    // Commented out because this creates CORS errors if not done exactly on API
-    // try {
-    //     let response = await fetch(url);
-    //     if (response.status !== 200) return false;
-    // } catch (_) {
-    //     return false;
-    // }
 
     let instanceList = fetchInstanceLists(storage);
     // network is already guaranteed to be in ALLOWED_NETWORKS and thus on the default list
@@ -150,7 +142,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/pageBuilder.js.html b/docs/pageBuilder.js.html
@@ -47,7 +47,6 @@ <h1 class="page-title">Source: pageBuilder.js</h1>
     nextPage.disabled = true;
     prevPage.disabled = true;
 
-    // TODO: sane pre-fetching solution that isn't just one instance
     let postsByNetwork = {};
     let maxLengthArray = 0;
     const instLists = fetchInstanceLists();
@@ -101,7 +100,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/paginator.js.html b/docs/paginator.js.html
@@ -125,7 +125,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/postBuilder_LemmyPostBuilder.js.html b/docs/postBuilder_LemmyPostBuilder.js.html
@@ -105,7 +105,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/postBuilder_MastodonPostBuilder.js.html b/docs/postBuilder_MastodonPostBuilder.js.html
@@ -29,22 +29,6 @@ <h1 class="page-title">Source: postBuilder/MastodonPostBuilder.js</h1>
             <pre class="prettyprint source linenums"><code>import { PostBuilder } from "./PostBuilder.js";
 
 export class MastodonPostBuilder extends PostBuilder {
-    // TODO: review this function, remove if not needed
-    #interleaveArrays(responses) {
-        const maxLength = Math.max(...responses.map(response => response.length));
-        const result = [];
-
-        for (let i = 0; i &lt; maxLength; i++) {
-            for (let j = 0; j &lt; responses.length; j++) {
-                if (responses[j].length > i) {
-                    result.push(responses[j][i]);
-                }
-            }
-        }
-
-        return result;
-    }
-
     /**
      *
      * @param {Object} rawPost - The raw json data from the API
@@ -78,7 +62,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/postBuilder_PostBuilder.js.html b/docs/postBuilder_PostBuilder.js.html
@@ -57,7 +57,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="InstanceE
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:09:01 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Dec 13 2023 05:22:14 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>