Skip to content

Commit

Permalink
Implement ESDoc (#226)
Browse files Browse the repository at this point in the history
* Start on esdoc

* Beef up ESDoc comments, alphabetize class methods

* More comments

* Add more comments, refactor _setUpButtons
  • Loading branch information
RobbieTheWagner authored Aug 29, 2018
1 parent 1a9a323 commit 1c7a72a
Show file tree
Hide file tree
Showing 8 changed files with 702 additions and 192 deletions.
13 changes: 13 additions & 0 deletions .esdoc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
module.exports = {
source: './src',
destination: './esdoc',
plugins: [
{
name: 'esdoc-standard-plugin'
},
{
name: 'esdoc-ecmascript-proposal-plugin',
option: { all: true }
}
]
};
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
/coverage/
/cypress/
/dist/
/esdoc/
/node_modules/
/test/unit/dist
/.DS_Store
Expand Down
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
],
"scripts": {
"build": "yarn clean && webpack --mode production",
"esdoc": "esdoc",
"postbuild": "rm -f dist/removable-*",
"clean": "rm -rf dist",
"cy:open": "./node_modules/.bin/cypress open",
Expand Down Expand Up @@ -70,6 +71,9 @@
"css-loader": "^1.0.0",
"cypress": "^3.0.3",
"del": "^3.0.0",
"esdoc": "^1.1.0",
"esdoc-ecmascript-proposal-plugin": "^1.0.0",
"esdoc-standard-plugin": "^1.0.0",
"eslint": "^5.1.0",
"eslint-loader": "^2.1.0",
"eslint-plugin-mocha": "^5.1.0",
Expand Down
2 changes: 1 addition & 1 deletion src/js/bind.js
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ export function bindCancelLink(link) {

/**
* Take an array of strings and look up methods by name, then bind them to `this`
* @param {[String]} methods The names of methods to bind
* @param {String[]} methods The names of methods to bind
*/
export function bindMethods(methods) {
methods.map((method) => {
Expand Down
Loading

0 comments on commit 1c7a72a

Please sign in to comment.