Updates **many** jsdoc comments to improve generated docs

Renames several internals to public:
  `rendering._engine` to `engine`
  `rendering._camera` to `camera`
  `rendering._scene` to `scene`
  `rendering._light` to `light`

.eslintrc.js

@@ -10,7 +10,7 @@ module.exports = {
         "es6": true,
     },
     "parserOptions": {
-        "ecmaVersion": 10,
+        "ecmaVersion": 13,
         "sourceType": "module",
     },
     "rules": {

package.json

@@ -42,6 +42,7 @@
         "eslint": "^8.3.0",
         "js-beautify": "^1.14.0",
         "typedoc": "^0.24.6",
+        "typedoc-plugin-missing-exports": "^2.0.0",
         "typescript": "^5.0.4"
     },
     "keywords": [

src/components/movement.js

@@ -1,7 +1,3 @@
-/** 
- * @module
- * @internal
- */
 
 import vec3 from 'gl-vec3'
 

src/index.js

@@ -1,4 +1,3 @@
-/** @module noa */
 
 /*!
  * noa: an experimental voxel game engine.
@@ -18,8 +17,8 @@ import { Inputs } from './lib/inputs'
 import { Container } from './lib/container'
 import { Camera } from './lib/camera'
 import { Entities } from './lib/entities'
-import ObjectMesher from './lib/objectMesher'
-import TerrainMesher from './lib/terrainMesher'
+import { ObjectMesher } from './lib/objectMesher'
+import { TerrainMesher } from './lib/terrainMesher'
 import { Registry } from './lib/registry'
 import { Rendering } from './lib/rendering'
 import { Physics } from './lib/physics'
@@ -73,12 +72,6 @@ var defaultOptions = {
  * child modules ({@link Rendering}, {@link Container}, etc).
  * See docs for each module for their options.
  * 
- * @emits tick(dt)
- * @emits beforeRender(dt)
- * @emits afterRender(dt)
- * @emits targetBlockChanged(blockDesc)
- * @emits addingTerrainMesh(mesh)
- * @emits removingTerrainMesh(mesh)
 */
 
 export class Engine extends EventEmitter {
@@ -105,6 +98,20 @@ export class Engine extends EventEmitter {
      *    originRebaseDistance: 25,
      * }
      * ```
+     * 
+     * **Events:**
+     *  + `tick => (dt)`  
+     *    Tick update, `dt` is (fixed) tick duration in ms
+     *  + `beforeRender => (dt)`  
+     *    `dt` is the time (in ms) since the most recent tick
+     *  + `afterRender => (dt)`  
+     *    `dt` is the time (in ms) since the most recent tick
+     *  + `targetBlockChanged => (blockInfo)`  
+     *    Emitted each time the user's targeted world block changes
+     *  + `addingTerrainMesh => (mesh)`  
+     *    Alerts client about a terrain mesh being added to the scene
+     *  + `removingTerrainMesh => (mesh)`  
+     *    Alerts client before a terrain mesh is removed.
     */
     constructor(opts = {}) {
         super()
@@ -313,7 +320,7 @@ export class Engine extends EventEmitter {
             win.noa = this
             win.vec3 = vec3
             win.ndarray = ndarray
-            win.scene = this.rendering._scene
+            win.scene = this.rendering.scene
         }
 
         // add hooks to throw helpful errors when using deprecated methods

src/lib/camera.js

@@ -1,7 +1,3 @@
-/** 
- * The Camera class is found at [[Camera | `noa.camera`]].
- * @module noa.camera
- */
 
 import vec3 from 'gl-vec3'
 import aabb from 'aabb-3d'
@@ -36,7 +32,7 @@ var originVector = vec3.create()
  * mouse sensitivity, and so on.
  * 
  * This module uses the following default options (from the options
- * object passed to the [[Engine]]):
+ * object passed to the {@link Engine}):
  * ```js
  * var defaults = {
  *     inverseX: false,

src/lib/chunk.js

@@ -1,7 +1,3 @@
-/** 
- * @module
- * @internal
- */
 
 import { LocationQueue } from './util'
 import ndarray from 'ndarray'
@@ -73,6 +69,7 @@ export function Chunk(noa, requestID, ci, cj, ck, size, dataArray, fillVoxelID =
     this._timesMeshed = 0
 
     // location queue of voxels in this chunk with block handlers (assume it's rare)
+    /** @internal */
     this._blockHandlerLocs = new LocationQueue()
 
     // passes through voxel contents, calling block handlers etc.

src/lib/container.js

@@ -1,7 +1,3 @@
-/** 
- * The Container class is found at [[Container | `noa.container`]].
- * @module noa.container
- */
 
 import { EventEmitter } from 'events'
 import { MicroGameShell } from 'micro-game-shell'
@@ -16,9 +12,13 @@ import { MicroGameShell } from 'micro-game-shell'
  * 
  * This module wraps `micro-game-shell`, which does most of the implementation.
  * 
- * @emits DOMready
- * @emits gainedPointerLock
- * @emits lostPointerLock
+ * **Events**
+ *  + `DOMready => ()`  
+ *    Relays the browser DOMready event, after noa does some initialization
+ *  + `gainedPointerLock => ()`  
+ *    Fires when the game container gains pointerlock.
+ *  + `lostPointerLock => ()`  
+ *    Fires when the game container loses pointerlock.
  */
 
 export class Container extends EventEmitter {

src/lib/entities.js

@@ -1,7 +1,3 @@
-/** 
- * The ECS manager, found at [[Entities | `noa.entities`]] or [[Entities | `noa.ents`]].
- * @module noa.entities
- */
 
 import ECS from 'ent-comp'
 import vec3 from 'gl-vec3'
@@ -40,7 +36,7 @@ var defaultOptions = {
  * folder for examples.
  * 
  * This module uses the following default options (from the options
- * object passed to the [[Engine]]):
+ * object passed to the {@link Engine}):
  * 
  * ```js
  * var defaults = {

src/lib/inputs.js

@@ -1,8 +1,3 @@
-/** 
- * The Inputs class is found at [[Inputs | `noa.inputs`]].
- * @module noa.inputs
- */
-
 
 import { GameInputs } from 'game-inputs'
 
@@ -32,7 +27,7 @@ var defaultBindings = {
  * for full docs.
  * 
  * This module uses the following default options (from the options
- * object passed to the [[Engine]]):
+ * object passed to the {@link Engine}):
  * 
  * ```js
  *   defaultBindings: {

src/lib/objectMesher.js

@@ -1,13 +1,8 @@
-/** 
- * @module 
- * @internal exclude this file from API docs 
-*/
 
 import { TransformNode } from '@babylonjs/core/Meshes/transformNode'
 import { makeProfileHook } from './util'
 import '@babylonjs/core/Meshes/thinInstanceMesh'
 
-export default ObjectMesher
 
 var PROFILE = 0
 
@@ -26,11 +21,14 @@ var PROFILE = 0
 */
 
 
-/** @param {import('../index').Engine} noa*/
-function ObjectMesher(noa) {
+/** 
+ * @internal
+ * @param {import('../index').Engine} noa
+*/
+export function ObjectMesher(noa) {
 
     // transform node for all instance meshes to be parented to
-    this.rootNode = new TransformNode('objectMeshRoot', noa.rendering._scene)
+    this.rootNode = new TransformNode('objectMeshRoot', noa.rendering.scene)
 
     // tracking rebase amount inside matrix data
     var rebaseOffset = [0, 0, 0]

src/lib/physics.js

@@ -1,8 +1,3 @@
-/** 
- * The Physics class is found at [[Physics | `noa.physics`]].
- * @module noa.physics
- */
-
 
 import { Physics as VoxelPhysics } from 'voxel-physics-engine'
 
@@ -23,7 +18,7 @@ var defaultOptions = {
  * for full docs.
  * 
  * This module uses the following default options (from the options
- * object passed to the [[Engine]]):
+ * object passed to the {@link Engine}):
  * 
  * ```js
  * {

src/lib/registry.js

@@ -1,7 +1,3 @@
-/** 
- * The Registry class is found at [[Registry | `noa.registry`]].
- * @module noa.registry
- */
 
 
 var defaults = {
@@ -20,7 +16,7 @@ var MAX_BLOCK_ID = (1 << 16) - 1
  * materials, properties, and events.
  * 
  * This module uses the following default options (from the options
- * object passed to the [[Engine]]):
+ * object passed to the {@link Engine}):
  * 
  * ```js
  * var defaults = {
@@ -178,7 +174,7 @@ export class Registry {
 
         this.registerMaterial = function (name = '?', options = null) {
             // catch calls to earlier signature
-            if (Array.isArray(options) || arguments[2]) {
+            if (Array.isArray(options)) {
                 throw 'This API changed signatures in v0.33, please use: `noa.registry.registerMaterial("name", optionsObj)`'
             }
 
@@ -266,6 +262,7 @@ export class Registry {
         /**
          * Given a texture URL, does any material using that 
          * texture need alpha?
+         * @internal
          * @returns {boolean}
          */
         this._textureNeedsAlpha = function (tex = '') {