docs(src): docs

update doc generation script && typo

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 dist/*.js
 .env
+docs

jsdoc.json

@@ -0,0 +1,12 @@
+{
+  "source": {
+    "includePattern": ".+\\.js(doc|x)?$",
+    "include": ["."],
+    "exclude": ["node_modules"]
+  },
+  "recurseDepth": 10,
+  "opts": {
+    "destination": "./docs/",
+    "recurse": true
+  }
+}

package.json

@@ -7,7 +7,9 @@
     "build": "webpack --config webpack.config.js --mode=production",
     "dev": "npm run build && nodemon './src/paymob-marketplace'",
     "commit": "git-cz",
-    "local:server": "nodemon './src/paymob-marketplace'"
+    "local:server": "nodemon './src/paymob-marketplace'",
+    "generate:doc": "jsdoc -c './jsdoc.json'"
+
   },
   "repository": {
     "type": "git",

src/http/HTTPRequest.js

@@ -4,7 +4,6 @@ import { requester } from "./_requester";
 
 /**
  * Wanna a request!, it's HTTPRequest class.
- * @export
  * @class HTTPRequest
  */
 export class HTTPRequest {

src/intention/Intention.js

@@ -7,7 +7,6 @@ import { getApiBaseUrl, getApiVersion } from "../utils";
 
 /**
  * Intention operations (create, update, patch, delete, retrieve, list)
- * @export
  * @class Intention
  */
 export class Intention {

src/utils/_getApiBaseUrl.js

@@ -1,5 +1,5 @@
 /**
- * return current api version
+ * return current api domain
  * @name getApiBaseUrl
  * @return {*}
 */

src/utils/_paymobLogger.js

@@ -1,5 +1,5 @@
 /**
- * paymonb logger util
+ * paymob logger util
  * @param {string} msg
  * @param {string} [level='log']
  * @name paymobLogger