17
edits
Jetpack/SDK/Writing Documentation: Difference between revisions
Jetpack/SDK/Writing Documentation (view source)
Revision as of 20:28, 18 August 2010
, 18 August 2010→A Short, Well Documented Example
| Line 47: | Line 47: | ||
This is a good example of a well documented API within the Jetpack SDK. This is directly from the tabs.md API document. It has 2 major parts: | This is a good example of a well documented API within the Jetpack SDK. This is directly from the tabs.md API document. It has 2 major parts: | ||
* | *APIDoc formatted API reference with a human-readable description | ||
*A short code sample of using the API in context | *A short code sample of using the API in context | ||
More complex examples can be found in the .md files located in the jetpack-core/docs directory. The APIDoc format is reasonably robust and the tight feedback loop of being able to immediately view your changes in the documentation engine ("cfx docs") should make updating and authoring API docs relatively straightforward. | |||
Additionally, questions can be directed to the [http://groups.google.com/group/mozilla-labs-jetpack/topics?pli=1 Google Group for Jetpack]. | |||
== Submitting changes/updates to jetpack-core Documentation == | == Submitting changes/updates to jetpack-core Documentation == | ||