Added jsDoc for generated APIs
diff --git a/xos/core/xoslib/ngXosLib/README.md b/xos/core/xoslib/ngXosLib/README.md
index bbe087f..63c1499 100644
--- a/xos/core/xoslib/ngXosLib/README.md
+++ b/xos/core/xoslib/ngXosLib/README.md
@@ -12,6 +12,8 @@
This tool will automatically generate an angular resource file for each endpoint available in Swagger.
+>You can generate api related documentation with: `npm run apidoc`. The output is locate in `api/docs`. You can have a list of available method also trough Swagger at `http://localhost:9999/docs/`
+
### Vendors
Xos comes with a preset of common libraries, as listed in `bower.json`:
diff --git a/xos/core/xoslib/ngXosLib/package.json b/xos/core/xoslib/ngXosLib/package.json
index c1a7874..045699c 100644
--- a/xos/core/xoslib/ngXosLib/package.json
+++ b/xos/core/xoslib/ngXosLib/package.json
@@ -6,7 +6,8 @@
"scripts": {
"test": "karma start",
"apigen": "node xos-resource-generator.js",
- "swagger": "node xos-swagger-def.js"
+ "swagger": "node xos-swagger-def.js",
+ "apidoc": "jsdoc api/ng-xos.js api/ng-xoslib.js api/ng-hpcapi.js -d api/docs"
},
"author": "Matteo Scandolo",
"license": "ISC",
@@ -15,6 +16,7 @@
"chalk": "^1.1.1",
"concat": "^1.0.0",
"fetch-swagger-schema": "^0.1.2",
+ "jsdoc": "^3.3.3",
"swagger-js-codegen": "^1.1.5"
},
"devDependencies": {