569698 - convert collection.md to apidocs format

Status: RESOLVED FIXED

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

Description

[Noelle Murata]

<et al>

Comment 1

[Noelle Murata]

Attachment: update collections.md to api docs format

Comment 2

[Drew Willcoxon :adw]

Comment on attachment 449920 [details] [diff] [review]
update collections.md to api docs format

Looks great, thanks.

>-<code>Collection.**add**(*itemOrItems*)</code>
>+<api name="add">
>+@method
>+Adds a single item or an array of items to the collection.  Any items already
>+contained in the collection are ignored.
>+@param itemOrItems {object} An item or array of items.

The only question I have is about specifying "object" as the type here.  That's technically correct, but do you think it would be more helpful to specify "object or array"?  Up to you.

>-<code>Collection.**remove**(*itemOrItems*)</code>
>+<api name="remove">
>+@method
>+Removes a single item or an array of items from the collection.  Any items not
>+contained in the collection are ignored.
>+@param itemOrItems {object} An item or array of items.

Here too.

Comment 3

[Drew Willcoxon :adw]

Bug 570850 makes my suggestion not possible right now, so pushed:

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

Comment 4

[Drew Willcoxon :adw]

D'oh, wrong link, here's the right one:

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

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