Skip to content

Commit

Permalink
API doc generation overhaul.
Browse files Browse the repository at this point in the history
 * moves all class property docs inline with the property declaration
 * updates typedoc and typescript deps
 * change to typedoc default theme, as cooler theme is now unsupported
 * remove some workarounds for typedoc 0.20 bugs
 * a few manual edits to external types
  • Loading branch information
fenomas committed Oct 4, 2021
1 parent 1c3c9bf commit d523d25
Show file tree
Hide file tree
Showing 22 changed files with 538 additions and 508 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ Recent changes:
* `v0.31`:
* Change the speed of the world! See `noa.timeScale`
* Now possible to control chunk processing order: `noa.world.chunkSortingDistFn`
* Much improved type exports and [API docs](https://fenomas.github.io/noa/API/)
* `v0.30`:
* Engine now a named class, use `import {Engine} from 'noa-engine'`
* many performance and size optimizations
Expand Down
3 changes: 3 additions & 0 deletions docs/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ This is a summary of new features and breaking changes in recent `noa` versions.
### 0.31.0

* Change the speed of the world with `noa.timeScale`
* Now possible to control chunk processing order: `noa.world.chunkSortingDistFn`
* Chunk processing will happen more reliably, particularly after switching worlds.
* Changed how the docs work, and how code comments are arranged for this purpose. See [API docs](https://fenomas.github.io/noa/API/).


### 0.30.0
Expand Down
15 changes: 7 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
"/dist"
],
"scripts": {
"build": "tsc; typedoc",
"build": "npm run types; npm run docs",
"types": "tsc",
"docs": "typedoc"
"docs": "typedoc --tsconfig tsdoc-config.json"
},
"author": "Andy Hall (https://fenomas.com)",
"license": "MIT",
Expand All @@ -30,20 +30,19 @@
"fast-voxel-raycast": "^0.1.1",
"game-inputs": "^0.4.0",
"gl-vec3": "^1.1.3",
"micro-game-shell": "^0.2.0",
"micro-game-shell": "^0.3.0",
"ndarray": "^1.0.19",
"voxel-aabb-sweep": "^0.5.0",
"voxel-physics-engine": "^0.11.0"
"voxel-physics-engine": "^0.11.1"
},
"peerDependencies": {
"@babylonjs/core": "^4.2.0"
"@babylonjs/core": "5.0.0-alpha.48"
},
"devDependencies": {
"eslint": "^7.26.0",
"js-beautify": "^1.13.13",
"typedoc": "^0.20.36",
"typedoc-neo-theme": "^1.1.1",
"typescript": "4.2"
"typedoc": "^0.22.5",
"typescript": "^4.4.3"
},
"keywords": [
"voxel",
Expand Down
4 changes: 4 additions & 0 deletions src/components/movement.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/** @module noa.ents.comps.movement */

import vec3 from 'gl-vec3'

Expand Down Expand Up @@ -29,8 +30,11 @@ export function MovementState() {
this.airJumps = 1

// internal state
/** @internal */
this._jumpCount = 0
/** @internal */
this._currjumptime = 0
/** @internal */
this._isJumping = false
}

Expand Down
Loading

0 comments on commit d523d25

Please sign in to comment.