Changed to esdoc.

This commit is contained in:
Harrison Deng 2022-04-17 21:13:12 -05:00
parent 3b4849a602
commit 2dc3bd1cd6
5 changed files with 2500 additions and 364 deletions

27
.esdoc.json Normal file
View File

@ -0,0 +1,27 @@
{
"source": "./src",
"destination": "./docs",
"plugins": [
{
"name": "esdoc-standard-plugin",
"option": {
"test": {
"source": "./tests/",
"interfaces": [
"describe",
"it",
"context",
"suite",
"test"
],
"includes": [
"(spec|Spec|test|Test)\\.js$"
],
"excludes": [
"\\.config\\.js$"
]
}
}
}
]
}

View File

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

2811
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -10,21 +10,21 @@
"build:dev": "webpack --config webpack.dev.cjs",
"build": "webpack --config webpack.dev.cjs",
"test": "mocha tests/** --reporter mocha-junit-reporter --reporter-options mochaFile=./junit/test_results.xml",
"docs": "jsdoc src README.md -r -d docs -c jsdoc.config.json"
"docs": "esdoc"
},
"author": "",
"license": "ISC",
"devDependencies": {
"@babel/core": "^7.17.9",
"@babel/preset-env": "^7.16.11",
"@ckeditor/jsdoc-plugins": "^20.0.0",
"babel-loader": "^8.2.4",
"chai": "^4.3.6",
"css-loader": "^6.7.1",
"esdoc": "^0.0.2",
"esdoc-standard-plugin": "^1.0.0",
"eslint": "^8.13.0",
"eslint-plugin-import": "^2.26.0",
"eslint-plugin-jsdoc": "^39.2.1",
"jsdoc": "^3.6.10",
"mocha": "^9.2.2",
"mocha-junit-reporter": "^2.0.2",
"style-loader": "^3.3.1",
@ -32,4 +32,4 @@
"webpack-cli": "^4.9.2",
"webpack-merge": "^5.8.0"
}
}
}

View File

@ -58,25 +58,25 @@ export default class PlayListSong {
*
* @returns {string} representing the name of the song to be displayed.
*/
getDisplayName = function () {
getDisplayName() {
return this._displayName;
};
}
/**
*
* @returns {string} representing the author of the song.
*/
getAuthor = function () {
getAuthor() {
return this._getAuthor;
};
}
/**
*
* @returns {string} representing the url at which the file for this song can be found.
*/
getUrl = function () {
getUrl() {
return this._url;
};
}
/**
*