WebPlatform Framework APIS

This is intended to be the home of a set of APIs used across the BlackBerry Web Platform for the upcoming BlackBerry10 OS.

Building

Build with jake

1. Run the configuration script (./configure or configure.bat)

2. Run the command:

    $ jake
   

Building with maven

1. Download and install maven

2. Run the command:

    $ mvn install
   

Docs

Setting up your Environment

1. If you don't already have one, download and configure a [Java Runtime Environment] (http://www.oracle.com/technetwork/java/javase/downloads/index.html) on your machine. Otherwise everything else is taken care of by the configuration scripts.

Building the Documentation

1. The docs are automatically created in the build process (jake build). You can also specifically build them by calling jake docs

Viewing the Documentation

After you have generated the documentation you will find all the HTML for the API docs in your docs folder

The documentation can also be viewed online on github at this link.

Additional Information

About the jsdoc-toolkit open source project

JsDoc Toolkit is an application used to document JavaScript interfaces and automatically generate template-formatted HTML documentation from commented JavaScript source code. It's similar to JavaDoc, where you can use tags like @param to document your APIs.

If you wish to read more information, or find out about more available tag references, please visit this link