search

tanelih / phonegap-bluetooth-plugin

Bluetooth plugin for PhoneGap version 2.6.0+
MIT License
57 stars 50 forks source link

Documentation #7

Closed sjobe closed 10 years ago

sjobe commented 10 years ago

Hello,

Is there any documentation available for this by any chance or do I have to read the js file to figure out what calls are available ?

Thanks

tanelih commented 10 years ago

Hi,

Unfortunately there's no formal documentation other than reading the javascript file. It is fairly short though.

However, the code is commented using the JSDoc format. You could generate HTML formatted documentation (for example) the following way:

First install JSDoc. I did this via NPM, so you'll need Node as well.

npm install -g jsdoc

This will install the module globally, so you can just run jsdoc from the command line.

jsdoc phonegap-bluetooth-plugin/www/bluetooth.js

You'll find the output in a folder called out, where you can open the index.html file to view the generated documentation!

Hope this helps

sjobe commented 10 years ago

That is helpful, thanks!