ydeng/audioshowkit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Returned to JSDoc.

Browse Source
This commit is contained in:
Harrison Deng 2022-04-18 02:12:43 -05:00
parent af0200a4a5
commit 8300bbe00c
7 changed files with 678 additions and 3032 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
audioshowkit/jsdoc.config.json Normal file
View File

@ -0,0 +1,6 @@
{
"plugins": [
"node_modules/@ckeditor/jsdoc-plugins/lib/export-fixer/export-fixer.js",
"node_modules/@ckeditor/jsdoc-plugins/lib/longname-fixer/longname-fixer.js"
]
}

3686
audioshowkit/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

8
audioshowkit/package.json
View File

@ -13,7 +13,7 @@
"test:console": "mocha tests/**", "test:console": "mocha tests/**",
"test": "npm run test:console", "test": "npm run test:console",
"watch": "webpack --watch --config webpack.dev.cjs", "watch": "webpack --watch --config webpack.dev.cjs",
"docs": "esdoc" "docs": "jsdoc src README.md -r -d docs -c jsdoc.config.json"
}, },
"author": "", "author": "",
"license": "ISC", "license": "ISC",
@ -21,15 +21,15 @@
"@babel/core": "^7.17.9", "@babel/core": "^7.17.9",
"@babel/eslint-parser": "^7.17.0", "@babel/eslint-parser": "^7.17.0",
"@babel/preset-env": "^7.16.11", "@babel/preset-env": "^7.16.11",
"@ckeditor/jsdoc-plugins": "^30.1.3",
"babel-loader": "^8.2.4", "babel-loader": "^8.2.4",
"chai": "^4.3.6", "chai": "^4.3.6",
"css-loader": "^6.7.1", "css-loader": "^6.7.1",
"esdoc": "^1.1.0",
"esdoc-standard-plugin": "^1.0.0",
"eslint": "^8.13.0", "eslint": "^8.13.0",
"eslint-plugin-import": "^2.26.0", "eslint-plugin-import": "^2.26.0",
"eslint-plugin-jsdoc": "^39.2.2", "eslint-plugin-jsdoc": "^39.2.2",
"eslint-webpack-plugin": "^3.1.1", "eslint-webpack-plugin": "^3.1.1",
"jsdoc": "^3.6.10",
"mocha": "^9.2.2", "mocha": "^9.2.2",
"mocha-junit-reporter": "^2.0.2", "mocha-junit-reporter": "^2.0.2",
"style-loader": "^3.3.1", "style-loader": "^3.3.1",
@ -37,4 +37,4 @@
"webpack-cli": "^4.9.2", "webpack-cli": "^4.9.2",
"webpack-merge": "^5.8.0" "webpack-merge": "^5.8.0"
} }
} }

2
audioshowkit/src/player/PlaylistSong.js
View File

@ -26,7 +26,7 @@ export default class PlayListSong {
} }
/** /**
* @typedef {Function} AudioEventCallback * @callback AudioEventCallback
* @param {HTMLAudioElement} audio * @param {HTMLAudioElement} audio
*/ */

2
audioshowkit/src/player/SongPlayer.js
View File

@ -241,7 +241,7 @@ export default class SongPlayer {
} }
/** /**
* @typedef {Function} changeListener * @callback changeListener
* @param {*} old the previous value. * @param {*} old the previous value.
* @param {*} current the the current (new) value. * @param {*} current the the current (new) value.
*/ */

2
audioshowkit/src/support/easings.js
View File

@ -1,6 +1,6 @@
/** /**
* @typedef {Function} interpolator * @callback interpolator
* @param {number} current the current value. * @param {number} current the current value.
* @param {number} dest the destination value. * @param {number} dest the destination value.
* @param {number} frameDelta the time elapsed since the last update. * @param {number} frameDelta the time elapsed since the last update.

4
audioshowkit/src/visualization/VisualizerUpdateManager.js
View File

@ -51,14 +51,14 @@ export default class VisualizerUpdateManager {
} }
/** /**
* @typedef {Function} visualizerBinUpdateListener * @callback visualizerBinUpdateListener
* @param {number} timeDelta elapsed time since last update. * @param {number} timeDelta elapsed time since last update.
* @param {number} amplitude The amplitude of the associated bin. * @param {number} amplitude The amplitude of the associated bin.
* @param {number} ampDelta change in amplitude of the frequency bin. * @param {number} ampDelta change in amplitude of the frequency bin.
*/ */
/** /**
* @typedef {Function} visualizerRangedUpdateListener * @callback visualizerRangedUpdateListener
* @param {number} timeDelta elapsed time since last update. * @param {number} timeDelta elapsed time since last update.
* @param {number} bins the bins of the range. * @param {number} bins the bins of the range.
*/ */