Closed Bug 560980 Opened 11 years ago Closed 10 years ago

xul-app module needs documentation

Categories

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

defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: dietrich, Assigned: adw)

References

Details

Attachments

(1 file, 1 obsolete file)

the module does not have any docs.
Blocks: 563284
Attached patch patch (obsolete) — Splinter Review
Let's do this thang.
Assignee: nobody → adw
Status: NEW → ASSIGNED
Attachment #467745 - Flags: review?(avarma)
Comment on attachment 467745 [details] [diff] [review]
patch

Awesome.

Some nits:

  * For the documentation of versionInRange, you might want to link to https://developer.mozilla.org/en/Toolkit_version_format#Comparing_versions

  * For the 'name' property, do we want to mention anything about l10n or the unbranded versions of products here? For instance, will 'name' be "Firefox" or "Minefield" if the user is running Minefield? If so, that means that we probably want to advise developers not to make any big functionality-based decisions based on the string. I think I may have once known the answers to these questions, but now I do not.

  * For 'platformVersion', do we want to say XULRunner/Gecko instead of just XULRunner? I keep getting confused as to what we're calling what now. If there is a glossary of Mozilla terms on MDC that explains and disambiguates between all these words it might be useful to link to here too.

Anyways, all just nits, feel free to commit as-is.
Attachment #467745 - Flags: review?(avarma) → review+
Attached patch patch v2Splinter Review
(In reply to comment #2)
>   * For the documentation of versionInRange, you might want to link to
> https://developer.mozilla.org/en/Toolkit_version_format#Comparing_versions

Good idea.

>   * For the 'name' property, do we want to mention anything about l10n or the
> unbranded versions of products here? For instance, will 'name' be "Firefox" or
> "Minefield" if the user is running Minefield?

`name` is "Firefox" on Minefield builds.  MDC has a page on nsIXULAppInfo with more info, so I linked to it.

>   * For 'platformVersion', do we want to say XULRunner/Gecko instead of just
> XULRunner?

Yeah, ugh.  I said "Gecko/XULRunner" here.  (MDC says "Gecko or XULRunner"...)
Attachment #467745 - Attachment is obsolete: true
http://hg.mozilla.org/labs/jetpack-sdk/rev/cc8e33ef9ff7
Status: ASSIGNED → RESOLVED
Closed: 10 years ago
Resolution: --- → FIXED
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".
Component: Jetpack SDK → General
Product: Mozilla Labs → Add-on SDK
QA Contact: jetpack-sdk → general
You need to log in before you can comment on or make changes to this bug.