GitHub - cblanco/YaaST: YaaST is an open source framework based on Titanium for developing hybrid multi-platform mobile apps for the enterprise

cblanco / YaaST Public

forked from bangslosan/YaaST

Notifications You must be signed in to change notification settings
Fork 0
Star 0

YaaST is an open source framework based on Titanium for developing hybrid multi-platform mobile apps for the enterprise

View license

0 stars 1 fork Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 118 Commits
doc		doc
.gitignore		.gitignore
API.Accelerometer.js		API.Accelerometer.js
API.Battery.js		API.Battery.js
API.Camera.js		API.Camera.js
API.Contacts.js		API.Contacts.js
API.FileSystem.js		API.FileSystem.js
API.Map.Dummy.js		API.Map.Dummy.js
API.Map.js		API.Map.js
API.Media.js		API.Media.js
API.Network.js		API.Network.js
API.Notification.js		API.Notification.js
API.System.js		API.System.js
API.UI.js		API.UI.js
API.Utils.js		API.Utils.js
API.Wiring.js		API.Wiring.js
API.js		API.js
APIBridgeJS.lib		APIBridgeJS.lib
LICENSE		LICENSE
README		README

Repository files navigation

Documentation is generated with JsDoc (http://usejsdoc.org/index.html)

**** Configure it to read lib files ****
In conf.json, set source.includePattern as ".+\\.(js|lib|jsdoc)?$"

**** Generate documentation ****
To generate the documentation of the API:
jsdoc -d <doc_destination> <js_files...>
Example:
jsdoc -d .\doc\API .\API.js .\API.Map.js


**** Run JsDoc from Eclipse ****
You can run jsdoc_toolkit from within eclipse or Aptana by setting up Run -> External Tools -> Open External Tools Dialog...

Location
C:\DirectoryToWhereJavaIsLocated\Java\jre1.6.0_07\bin\java.exe

Working Directory
C:\DirectoryToWhereJsDocToolkitIsLocated\jsdoc-toolkit

Arguments
-jar jsrun.jar app\run.js "C:\PathToSourceFiles" -t=templates\jsdoc -d="C:\PathToOutputDirectory"

Note: You need to enclose the paths in quotes if they contain spaces (at least on windows)