This repository contains all of the BlackBerry WebWorks API documentation source as well as the build templates to transform the content into HTML documentation. The documentation source format is based on the jsdoc-toolkit open source project.
This project is Open Sourced under the Apache 2.0 license
Read more about the BlackBerry WebWorks open source project
Setting up your Environment
Download the jsdoc-toolkit
Extract the contents of the downloaded jsdoc zip file to a location on your machine <jsdoc-location>
Download the contents of this WebWorks-APIDocs repository to a <webworks-apidocs-location> of your choice
Copy the <webworks-apidocs-location>/build/BBTemplate directory from this repository to the <jsdoc-location>/jsdoc-toolkit/templates/BBTemplate directory
Copy the <webworks-apidocs-location>/build/bbPlugin.js file from this repository to <jsdoc-location>/jsdoc-toolkit/app/plugins/bbPlugin.js
If you don't already have one, download and configure a Java Runtime Environment on your machine
Building the Documentation
Open a command prompt to your <jsdoc-location>/jsdoc-toolkit directory. This directory should contain jsrun.jar
Type in the following command:
java -jar jsrun.jar app/run.js -a "<webworks-apidocs-location>/api" -t=templates/BBTemplate -d="<some-output-folder>" -u
Viewing the Documentation
After you have generated the documentation you will find all the HTML for the API docs in your <some-output-folder>/view. The default main page is topics.html.
The documentation can also be viewed online on github at this link.
Coming soon: Jsdocs best practices standard for adding metadata tags
About the jsdoc-toolkit open source project
If you wish to read more information, or find out about more available tag references, please visit this link