571114 - Programs (main.js) need more documentation

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: General, defect)

Description

[Drew Willcoxon :adw]

Programs (or maybe just main.js) need to be documented more thoroughly, especially since bug 549324 added support for exporting an onUnload method, which is intended for use by high-level developers.  We'll need to be able to point those developers to docs when we release 0.5.  Right now there's only an example in the tutorial section.

Comment 1

[Drew Willcoxon :adw]

Noelle, any thoughts on how this might fit into the current doc structure?

Comment 2

[Noelle Murata]

*nod* I think this should fit with the restructure (https://bugzilla.mozilla.org/show_bug.cgi?id=565204) but if it somehow slips; I can add a blurb re: onUnload to the current "Programs" page.

Comment 4

[Drew Willcoxon :adw]

Attachment: patch for 0.5

Instead of making a new Programs section in the appendix like I had planned, it seems sufficient for 0.5 to add a subsection to the Programs section in the tutorial.  The subsection is small enough that I think it doesn't get in the tutorial's way.  When the doc restructurings of bug 565204 and bug 571285 land, this subsection can find a better home.

Comment 5

[Drew Willcoxon :adw]

Comment on attachment 451786 [details] [diff] [review]
patch for 0.5

Atul, it'd be great if you could do a quick review too.  In addition to adding a new subsection to Programs about main() and onUnload(), I updated the glossary entry for Jetpack Program, and changed "activate" terminology to "load" and "unload".

Comment 6

[Atul Varma [:atul]]

Comment on attachment 451786 [details] [diff] [review]
patch for 0.5

Yeah! I like it, great explanations.

Comment 7

[Myk Melez [:myk] [@mykmelez]]

Comment on attachment 451786 [details] [diff] [review]
patch for 0.5

This all looks great, r=myk + a=myk for landing during the freeze.

Comment 8

[Drew Willcoxon :adw]

http://hg.mozilla.org/labs/jetpack-sdk/rev/03a61f944c4d

Comment 9

[Myk Melez [:myk] [@mykmelez]]

The Add-on SDK is no longer a Mozilla Labs experiment and has become a big enough project to warrant its own Bugzilla product, so the "Add-on SDK" product has been created for it, and I am moving its bugs to that product.

To filter bugmail related to this change, filter on the word "looptid".