Added npm run typedoc and npm run dev-typedoc scripts, read the DevelopmentWorkflow.mk

This commit is contained in:
Panayot Cankov
2016-10-06 17:52:14 +03:00
parent ed36106e9e
commit 43ceefdc03
3 changed files with 30 additions and 1 deletions

View File

@@ -89,3 +89,14 @@ npm run dev-declarations
```
This script will update the iOS declarations. Android tools are not integrated yet.
The declarations are generated from the test app and will include the native code from tns-core-modules-widgets.
# Documentation API reference
The following will build the API reference pages in `bin/dist/apiref`:
```
npm run typedoc
```
If you want to improve on the documentation you can also build and start up dev web server:
```
npm run dev-typedoc
```
The terminal will point the address you can open in your web browsed.