560980 - xul-app module needs documentation

Status: RESOLVED FIXED

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

Description

[Dietrich Ayala (:dietrich)]

the module does not have any docs.

Comment 1

[Drew Willcoxon :adw]

Attachment: patch

Let's do this thang.

Comment 2

[Atul Varma [:atul]]

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.

Comment 3

[Drew Willcoxon :adw]

Attachment: patch v2

(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"...)

Comment 4

[Drew Willcoxon :adw]

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

Comment 5

[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".