commit | 012f0a8381f222a234d33a4f63ac23cad6e9154d | [log] [tgz] |
---|---|---|
author | Shazron Abdullah <shazron@gmail.com> | Wed May 18 17:45:49 2011 -0700 |
committer | Shazron Abdullah <shazron@gmail.com> | Wed May 18 17:48:31 2011 -0700 |
tree | 9824b4f2750de83a28da614953bdfe557a01802e | |
parent | 149b8cd5b61e00abfee487c73ad64057ca5376a4 [diff] |
Removed isIpAddress option for network.isReachable. NetworkStatus is an object with code(int) and message(string) properties. This function will superseded by the Network Info API (network.connection) in a future update.
The public API documentation for PhoneGap. The documentation is rendered as the PhoneGap API Documentation website.
All of the PhoneGap documentation is written with markdown, a lightweight markup language that can be typeset to HTML. Markdown provides a simple and flexible way to document PhoneGap's core API and platform-specific APIs.
docs/ docs/phonegap/ docs/phonegap/class_name/ docs/phonegap/class_name/class_name.md docs/phonegap/class_name/class_name.method_name.md
Currently, PhoneGap-Docs uses joDoc to generate HTML documentation from the set of Markdown files.
Clone joDoc
git clone http://github.com/davebalmer/joDoc.git
Add joDoc/ to your path
Open ~/.bashrc
or ~/.profile
(or whatever you use)
export PATH=$PATH:~/path/to/joDoc/
Install markdown
# Use your package manager brew install markdown port install markdown aptitude install markdown
Install nokogiri (Ruby HTML parser)
gem install nokogiri
cd phonegap-docs ./bin/phonegap-docs
Install rspec:
gem install rspec --version 1.3.0
Run all specs:
cd phonegap-docs rake
Run a specific spec:
cd phonegap-docs spec spec/phonegap/add_title_spec.rb