Permalink
Browse files

Moved docs into javascripts directory and updated README file

  • Loading branch information...
1 parent d8e6c72 commit a1bffb976f6de277d69ed2dcc86ff61a963d79fd @NachoMan committed Apr 20, 2009
Showing with 40 additions and 23 deletions.
  1. +18 −1 README.md
  2. +1 −1 Rakefile
  3. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/files.html
  4. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/index.html
  5. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/Acceleration.html
  6. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/AccelerationOptions.html
  7. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/Accelerometer.html
  8. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/Camera.html
  9. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/Contact.html
  10. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/DebugConsole.html
  11. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/Device.html
  12. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/Geolocation.html
  13. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/Media.html
  14. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/MediaError.html
  15. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/Orientation.html
  16. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/PhoneGap.html
  17. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/Position.html
  18. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/PositionError.html
  19. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/PositionOptions.html
  20. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/Sms.html
  21. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/Telephony.html
  22. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/UIControls.html
  23. +1 −1 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/_global_.html
  24. 0 {util/jsdoc-toolkit/out/jsdoc → javascripts/docs}/symbols/src/tmp_phonegap.js.html
View
@@ -34,22 +34,39 @@ API
### Device
+Exposes properties of the phone, such as its device ID, model, and OS version number.
+
### Location
+
+Gain access to the Latitude / Longitude of the device, and depending on the type of device, the course, speed, and altitude.
### Accelerometer
+
+Monitor the accelerometer on the device to detect orientation, shaking and other similar actions.
### Contacts
+Query the phone addressbook to read the users contacts.
+
### Orientation
+Read the device layout orientation, e.g. landscape vs portrait.
+
### Camera
+Brings up the camera or photo browser on the phone to allow the user to upload a photo.
+
### Vibrate
+Triggers the vibration alert on the phone, if it is supported.
+
### Sound
+Play sound files (WAV, MP3, etc).
+
### Telephony
+Trigger and activate phone calls.
XUI
-------------------------------------------------------------
@@ -91,4 +108,4 @@ THE SOFTWARE.
-------------------------------------------------------------
-*phonegap is a [nitobi](http://nitobi.com) sponsored project*
+*phonegap is a [nitobi](http://nitobi.com) sponsored project*
View
@@ -22,7 +22,7 @@ def doc
end
FileUtils.mkdir_p "#{ LIBPATH }tmp"
open(final,'w'){|f| f.puts( js )}
- sh "java -jar util#{ File::SEPARATOR }jsdoc-toolkit#{ File::SEPARATOR }jsrun.jar util#{ File::SEPARATOR }jsdoc-toolkit#{ File::SEPARATOR }app#{ File::SEPARATOR }run.js -a -t=util#{ File::SEPARATOR }jsdoc-toolkit#{ File::SEPARATOR }templates#{ File::SEPARATOR }jsdoc tmp#{ File::SEPARATOR }phonegap.js"
+ sh "java -jar util#{ File::SEPARATOR }jsdoc-toolkit#{ File::SEPARATOR }jsrun.jar util#{ File::SEPARATOR }jsdoc-toolkit#{ File::SEPARATOR }app#{ File::SEPARATOR }run.js -a -d=javascripts/docs -t=util#{ File::SEPARATOR }jsdoc-toolkit#{ File::SEPARATOR }templates#{ File::SEPARATOR }jsdoc tmp#{ File::SEPARATOR }phonegap.js"
end
def build
@@ -246,7 +246,7 @@ <h1 class="classTitle">File Index</h1>
</div>
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:53 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -348,7 +348,7 @@ <h1 class="classTitle">Class Index</h1>
</div>
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:53 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -502,7 +502,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:09 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -385,7 +385,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:09 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -571,7 +571,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:09 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -408,7 +408,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:09 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -408,7 +408,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:09 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -486,7 +486,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:09 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -330,7 +330,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:09 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -661,7 +661,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:09 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -464,7 +464,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:09 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -328,7 +328,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:09 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -557,7 +557,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:09 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -510,7 +510,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:09 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -654,7 +654,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -328,7 +328,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -417,7 +417,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -420,7 +420,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:53 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -396,7 +396,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:53 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -330,7 +330,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:10 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:53 GMT-0700 (PDT)
</div>
</body>
</html>
@@ -616,7 +616,7 @@ <h1 class="classTitle">
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Thu Apr 16 2009 18:42:09 GMT-0700 (PDT)
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Apr 19 2009 17:47:52 GMT-0700 (PDT)
</div>
</body>
</html>

0 comments on commit a1bffb9

Please sign in to comment.