Merge branch 'master' into production

ankitskvmdam · Sep 25, 2023 · ef98f0e · ef98f0e
2 parents 5eefb20 + d7d968b
commit ef98f0e
Show file tree

Hide file tree

Showing 212 changed files with 31,302 additions and 385 deletions.
diff --git a/README.md b/README.md
diff --git a/demo/src/Alive.js b/demo/src/Alive.js
@@ -34,6 +34,7 @@ class Alive {
          * function test() {
          *  return world
          * }
+         * @alias AliveEnergy
          */
         this.energy = null;
         /**
@@ -96,5 +97,13 @@ var pieOptions = {
      */
     get aLaMode() {
         return this.plain + ' with ice cream';
+    },
+
+    /**
+     * This is just a namespace functions.
+     * @param {number} args 
+     */
+    aNamespaceFunction(args) {
+
     }
-};
+};
diff --git a/demo/src/HideConstructor.js b/demo/src/HideConstructor.js
@@ -3,6 +3,10 @@
  * @hideconstructor
  */
 class Test {
+  /**
+   * 
+   * @param {number} hidemepls 
+   */
 	constructor(hidemepls) {
 		console.log('i am a constructor');
     }

diff --git a/demo/src/Modules.js b/demo/src/Modules.js
@@ -8,6 +8,15 @@ module.exports = {
     fib: function* gen() { }
 };
 
+/** Class that represents a colour */
+class Colour {
+    /** Create colour from rgb */
+    constructor(red, green, blue) {
+        let hex = n => n.toString(16).padStart(2, '0');
+        this.hex = '#' + [red, green, blue].map(hex).join('');
+    }
+}
+
 /** Darkens a color. */
 exports.darken = function (color, shade) { };
 

diff --git a/demo/src/NamespaceWithAlias.js b/demo/src/NamespaceWithAlias.js
@@ -0,0 +1,74 @@
+function create_public_interface(obj) {
+    /**
+     * @namespace obj.map
+     */
+    const map = obj.map;
+
+    /**
+     * Sample function that does nothing
+     * @memberOf obj.map
+     * @function
+     */
+    map.start = function () {}
+    /**
+     * This is an alias. It's original name is start9
+     * @memberOf obj.map
+     * @function
+     * @alias obj.map.aliasOfStart9
+     */
+    map.start9 = function () {}
+    /**
+     * Sample function that does nothing
+     * @memberOf obj.map
+     * @function
+     */
+    map.start1 = function () {}
+    /**
+     * Sample function that does nothing
+     * @memberOf obj.map
+     * @function
+     */
+    map.start2 = function () {}
+    /**
+     * Sample function that does nothing
+     * @memberOf obj.map
+     * @function
+     */
+    map.start3 = function () {}
+    /**
+     * Sample function that does nothing
+     * @memberOf obj.map
+     * @function
+     */
+    map.start4 = function () {}
+    /**
+     * Sample function that does nothing
+     * @memberOf obj.map
+     * @function
+     */
+    map.start5 = function () {}
+    /**
+     * Sample function that does nothing
+     * @memberOf obj.map
+     * @function
+     */
+    map.start6 = function () {}
+    /**
+     * Sample function that does nothing
+     * @memberOf obj.map
+     * @function
+     */
+    map.start7 = function () {}
+    /**
+     * Sample function that does nothing
+     * @memberOf obj.map
+     * @function
+     */
+    map.start8 = function () {}
+    /**
+     * Sample function that does nothing
+     * @memberOf obj.map
+     * @function
+     */
+    map.start0 = function () {}
+}
diff --git a/demo/src/tutorials/Other.html b/demo/src/tutorials/Other.html
@@ -7,5 +7,9 @@
 </head>
 <body>
     Other Tutorial
+    <div>
+        This is second line just to test search
+    </div>
+    This is not of any use please ignore these files. It is here only for testing purpose.<br />
 </body>
 </html>
diff --git a/helpers/Environment.html b/helpers/Environment.html
diff --git a/jsdoc-config.json b/jsdoc-config.json
@@ -3,7 +3,7 @@
         "allowUnknownTags": true
     },
     "source": {
-        "include": ["./demo/src", "./README.md"]
+        "include": ["./demo/src", "./README.md", "package.json"]
     },
     "plugins": ["plugins/markdown"],
     "opts": {
@@ -17,6 +17,7 @@
             "search": true,
             "homepageTitle": "Clean JSDoc Theme",
             "default_theme": "dark",
+            "exclude_inherited": false,
             "include_css": ["./demo/src/assets/style.css"],
             "include_js": ["./demo/src/assets/script.js"],
             "static_dir": ["./demo/src/assets/png", "./example"],
@@ -53,7 +54,8 @@
                     "js_external": "https://code.jquery.com/jquery-3.6.0.min.js",
                     "js_pre_processor": "babel"
                 }
-            }
+            },
+            "prefixModuleToSidebarItems_experimental": true
         }
     },
     "templates": {

diff --git a/output/v4/AgentScript.html b/output/v4/AgentScript.html
@@ -0,0 +1,9 @@
+<html>
+<body>
+  Hello world
+</body>
+<script type="module">
+  import * as agentscript from "https://unpkg.com/agentscript@0.10.19/dist/agentscript.js"
+  console.log('Agent', agentscript)
+</script>
+</html>
diff --git a/output/v4/Alive.html b/output/v4/Alive.html
diff --git a/output/v4/Alive.js.html b/output/v4/Alive.js.html
diff --git a/output/v4/AliveAlias.html b/output/v4/AliveAlias.html
diff --git a/output/v4/Apple.html b/output/v4/Apple.html
diff --git a/output/v4/Apple.js.html b/output/v4/Apple.js.html
diff --git a/output/v4/Database.html b/output/v4/Database.html
diff --git a/output/v4/Energy.html b/output/v4/Energy.html
diff --git a/output/v4/Energy.js.html b/output/v4/Energy.js.html
diff --git a/output/v4/Environment.html b/output/v4/Environment.html
diff --git a/output/v4/Environment.js.html b/output/v4/Environment.js.html
diff --git a/output/v4/HideConstructor.js.html b/output/v4/HideConstructor.js.html
diff --git a/output/v4/Modules.js.html b/output/v4/Modules.js.html
diff --git a/output/v4/NamespaceWithAlias.js.html b/output/v4/NamespaceWithAlias.js.html
diff --git a/output/v4/Statement.html b/output/v4/Statement.html
diff --git a/output/v4/StatementIterator.html b/output/v4/StatementIterator.html
diff --git a/output/v4/Test.html b/output/v4/Test.html
diff --git a/output/v4/Tree.html b/output/v4/Tree.html
diff --git a/output/v4/Tree.js.html b/output/v4/Tree.js.html
diff --git a/output/v4/World.html b/output/v4/World.html
diff --git a/output/v4/World.js.html b/output/v4/World.js.html
diff --git a/output/v4/api.js.html b/output/v4/api.js.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Alive.html b/output/v4/clean-jsdoc-theme/4.2.10/Alive.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Alive.js.html b/output/v4/clean-jsdoc-theme/4.2.10/Alive.js.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Apple.html b/output/v4/clean-jsdoc-theme/4.2.10/Apple.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Apple.js.html b/output/v4/clean-jsdoc-theme/4.2.10/Apple.js.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Database.html b/output/v4/clean-jsdoc-theme/4.2.10/Database.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Energy.html b/output/v4/clean-jsdoc-theme/4.2.10/Energy.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Energy.js.html b/output/v4/clean-jsdoc-theme/4.2.10/Energy.js.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Environment.html b/output/v4/clean-jsdoc-theme/4.2.10/Environment.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Environment.js.html b/output/v4/clean-jsdoc-theme/4.2.10/Environment.js.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/HideConstructor.js.html b/output/v4/clean-jsdoc-theme/4.2.10/HideConstructor.js.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Modules.js.html b/output/v4/clean-jsdoc-theme/4.2.10/Modules.js.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/NamespaceWithAlias.js.html b/output/v4/clean-jsdoc-theme/4.2.10/NamespaceWithAlias.js.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Statement.html b/output/v4/clean-jsdoc-theme/4.2.10/Statement.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/StatementIterator.html b/output/v4/clean-jsdoc-theme/4.2.10/StatementIterator.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Test.html b/output/v4/clean-jsdoc-theme/4.2.10/Test.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Tree.html b/output/v4/clean-jsdoc-theme/4.2.10/Tree.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/Tree.js.html b/output/v4/clean-jsdoc-theme/4.2.10/Tree.js.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/World.html b/output/v4/clean-jsdoc-theme/4.2.10/World.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/World.js.html b/output/v4/clean-jsdoc-theme/4.2.10/World.js.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/api.js.html b/output/v4/clean-jsdoc-theme/4.2.10/api.js.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/data/search.json b/output/v4/clean-jsdoc-theme/4.2.10/data/search.json
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/demo/src/assets/png/screen-1.png b/output/v4/clean-jsdoc-theme/4.2.10/demo/src/assets/png/screen-1.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/demo/src/assets/png/screen-2.png b/output/v4/clean-jsdoc-theme/4.2.10/demo/src/assets/png/screen-2.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/demo/src/assets/png/screen-3.png b/output/v4/clean-jsdoc-theme/4.2.10/demo/src/assets/png/screen-3.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/demo/src/assets/png/screen-4.png b/output/v4/clean-jsdoc-theme/4.2.10/demo/src/assets/png/screen-4.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/demo/src/assets/png/screen-5.png b/output/v4/clean-jsdoc-theme/4.2.10/demo/src/assets/png/screen-5.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/demo/src/assets/png/screen-6.png b/output/v4/clean-jsdoc-theme/4.2.10/demo/src/assets/png/screen-6.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/example/screen-1.png b/output/v4/clean-jsdoc-theme/4.2.10/example/screen-1.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/example/screen-2.png b/output/v4/clean-jsdoc-theme/4.2.10/example/screen-2.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/example/screen-3.png b/output/v4/clean-jsdoc-theme/4.2.10/example/screen-3.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/example/screen-4.png b/output/v4/clean-jsdoc-theme/4.2.10/example/screen-4.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/example/screen-5.png b/output/v4/clean-jsdoc-theme/4.2.10/example/screen-5.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/example/screen-6.png b/output/v4/clean-jsdoc-theme/4.2.10/example/screen-6.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/fonts/Inconsolata-Regular.ttf b/output/v4/clean-jsdoc-theme/4.2.10/fonts/Inconsolata-Regular.ttf
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/fonts/OpenSans-Regular.ttf b/output/v4/clean-jsdoc-theme/4.2.10/fonts/OpenSans-Regular.ttf
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/fonts/WorkSans-Bold.ttf b/output/v4/clean-jsdoc-theme/4.2.10/fonts/WorkSans-Bold.ttf
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/global.html b/output/v4/clean-jsdoc-theme/4.2.10/global.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/index.html b/output/v4/clean-jsdoc-theme/4.2.10/index.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/module-SqlJs.html b/output/v4/clean-jsdoc-theme/4.2.10/module-SqlJs.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/module-bookshelf.Book.html b/output/v4/clean-jsdoc-theme/4.2.10/module-bookshelf.Book.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/module-bookshelf.html b/output/v4/clean-jsdoc-theme/4.2.10/module-bookshelf.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/module-color_mixer-Colour.html b/output/v4/clean-jsdoc-theme/4.2.10/module-color_mixer-Colour.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/module-color_mixer.html b/output/v4/clean-jsdoc-theme/4.2.10/module-color_mixer.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/obj.map.html b/output/v4/clean-jsdoc-theme/4.2.10/obj.map.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/pieOptions.html b/output/v4/clean-jsdoc-theme/4.2.10/pieOptions.html
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/screen-1.png b/output/v4/clean-jsdoc-theme/4.2.10/screen-1.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/screen-2.png b/output/v4/clean-jsdoc-theme/4.2.10/screen-2.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/screen-3.png b/output/v4/clean-jsdoc-theme/4.2.10/screen-3.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/screen-4.png b/output/v4/clean-jsdoc-theme/4.2.10/screen-4.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/screen-5.png b/output/v4/clean-jsdoc-theme/4.2.10/screen-5.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/screen-6.png b/output/v4/clean-jsdoc-theme/4.2.10/screen-6.png
diff --git a/output/v4/clean-jsdoc-theme/4.2.10/script.js b/output/v4/clean-jsdoc-theme/4.2.10/script.js
@@ -0,0 +1 @@
+console.log('This is the new very new test script. If it runs then it means it is included.')