Merge pull request #7 from fxnoob/jsdoc

Jsdoc

Author: fxnoob

.gitignore

@@ -2,4 +2,5 @@
 node_modules/
 babel
 babelscripts@1.0.0
-dist/
+dist/
+out/

package.json

@@ -3,10 +3,13 @@
   "version": "1.0.0",
   "description": "",
   "main": "index.js",
+  "homepage": "https://fxnoob.github.io/chrome-extension-boilerplate",
   "scripts": {
     "start": "webpack-dev-server --config ./webpack.config.js --mode development",
     "dev": "webpack --watch --progress --colors --config webpack.config.js --mode=development",
     "build": "webpack --progress --colors --config webpack.config.js --mode=production",
+    "jsdoc": "jsdoc src -r",
+    "deploy_jsdoc": "yarn jsdoc &&  gh-pages -d out",
     "prettier_check_src": "prettier --check src/**/*.{js,jsx}",
     "prettier_check_popup": "prettier --check src/**/*.{js,jsx}",
     "prettier_check_option": "prettier --check src/**/*.{js,jsx}",
@@ -32,8 +35,12 @@
     "babel-loader": "^8.0.6",
     "copy-webpack-plugin": "^5.0.4",
     "file-loader": "^4.2.0",
+    "gh-pages": "^2.1.1",
+    "husky": "^3.0.9",
     "image-webpack-loader": "^5.0.0",
+    "jsdoc": "^3.6.3",
     "prettier": "1.18.2",
+    "pretty-quick": "^2.0.0",
     "react-hot-loader": "^4.12.10",
     "webpack": "^4.39.1",
     "webpack-cli": "^3.3.6",
@@ -44,8 +51,6 @@
     "@babel/runtime": "^7.5.5",
     "@material-ui/core": "^4.3.3",
     "@material-ui/icons": "^4.2.1",
-    "husky": "^3.0.9",
-    "pretty-quick": "^2.0.0",
     "react": "^16.8.6",
     "react-dom": "^16.8.6"
   }

src/background.js

@@ -2,6 +2,11 @@ import "@babel/polyfill";
 
 let AppInitState = 0; // it means app is off on startup
 
+/**
+ * Main extension functionality
+ *
+ * @class Main
+ */
 class Main {
   constructor() {}
   popUpClickSetup() {
@@ -13,11 +18,23 @@ class Main {
     });
   }
 
+  /**
+   * toggle app
+   *
+   * @method
+   * @memberof Main
+   */
   toggleApp = () => {
     AppInitState = AppInitState ? 0 : 1;
     return AppInitState;
   };
 
+  /**
+   * stop app
+   *
+   * @method
+   * @memberof Main
+   */
   stopApp = () => {
     AppInitState = 0;
   };