759868 - xpcom example 'extends' wrong?

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: Documentation, defect, P1)

Description

[Gregg Lind (Fx Strategy and Insights - Shield - Heartbeat )]

https://gist.github.com/2838598  works.

Comment 1

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

Lets punt on this to 1.9's cycle.

Comment 2

[Will Bamberg [:wbamberg]]

Attachment: add dcrewi to credits; fix a few typos.

Pull request 482 (https://github.com/mozilla/addon-sdk/pull/482) from @dcrewi already fixes the examples: this just adds dcrewi to the credits and fixes some other typos.

Comment 4

[Dave Townsend [:mossop]]

What's the status here?

Comment 5

[Will Bamberg [:wbamberg]]

I'll take this, and hope to get it into 1.10.

Comment 6

[Will Bamberg [:wbamberg]]

Attachment: a new pull request

I've rewritten the documentation for xpcom.

A few things came up while doing this:

1) Factory.description does not seem to be updated when I pass the "description" option to its constructor, it just keeps the default value. Is this intentional?

2) There seems to be a bit of inconsistency in the error handling for some of these functions: when Things aren't found, some throw errors, some do nothing or return null. Should we be consistent?

3) I don't understand how this:

    Cc[contractId].getService(Ci.nsISupports);

works. Where's that getService() defined? I would like to point to its definition from the docs.

Thanks for the review!

Comment 7

[Irakli Gozalishvili [:irakli] [:gozala] [@gozala]]

Comment on attachment 659404 [details]
a new pull request

This documentation is great, thanks Will!!

I also put few suggestion comments, I'm leaving it up to you to decide.

Comment 8

[[github robot]]

Commit pushed to master at https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/2f21eccea449a3e383e11aa69c91b54d85d7f700
Merge pull request #484 from wbamberg/759868

Bug 759868 - xpcom example 'extends' wrong?

Comment 9

[[github robot]]

Commit pushed to stabilization at https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/c3aec726eff8287aeb1d031c2920c8855e518ad4
Merge pull request #484 from wbamberg/759868

Bug 759868 - xpcom example 'extends' wrong?(cherry picked from commit 2f21eccea449a3e383e11aa69c91b54d85d7f700)