Jetpack/SDK/Writing Documentation: Difference between revisions

Jetpack/SDK/Writing Documentation (view source)

8 bytes removed , 18 August 2010

m

17

edits

@@ Line 45: / Line 45: @@
-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 example is directly from the tabs.md file. This and all API documentation should have 2 major parts:
-*APIDoc formatted API reference with a human-readable description
+* An APIDoc formatted API reference with a human-readable description
-*A short code sample of using the API in context
+* A short code sample 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.
+More examples can be found in the .md files located in the jetpack-core/docs directory. The APIDoc format is robust and 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].