609572 - Event Emitter needs it's "private" APIs documented

Status: RESOLVED FIXED

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

Description

[Dietrich Ayala (:dietrich)]

From the docs: "Please note that EventEmitter does not expose neither a method for emitting events nor a list of available event listeners as its public API. Obviously both are accessible but from the instance itself through the private API."

From looking at code using EventEmitter, it appears that these undocumented methods are used regularly by any consumer/implementer of it. If that's the case, then they should be documented.

Comment 1

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

Comment 2

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

(automatic reprioritization of 1.0 bugs)

Comment 3

[Will Bamberg [:wbamberg]]

Resetting the priority of this, as module development documentation is not a high priority at the moment.

Comment 4

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

(Pushing all open bugs to the --- milestone for the new triage system)

Comment 5

[Will Bamberg [:wbamberg]]

Attachment: a pull request

This adds a tutorial on creating event targets using "event/core" and "event/target".

It might be good to have a higher-level construct in the SDK docs called "Module Developer's Guide" or something, that could contain this, the basic "Creating Reusable Modules" guide, the to-be-written tutorial on implementing inheritance, and maybe something standalone on accessing gBrowser and XPCOM (at the moment that stuff is a bit buried inside "porting from XUL".

Comment 6

[Erik Vold [:erikvold] (please needinfo? me)]

I've made some notes on the pull request in github.

Comment 7

[[github robot]]

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

https://github.com/mozilla/addon-sdk/commit/1f3fef7651a533cfcc95cd9fa2c9823d5c7088d7
Merge pull request #509 from wbamberg/609572

Fix bug 609572 - Event Emitter needs it's "private" APIs documented r=erikvold

Comment 8

[[github robot]]

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

https://github.com/mozilla/addon-sdk/commit/d550d1b0d605552ad214eb83ed8c71a3b727396a
Merge pull request #509 from wbamberg/609572

Fix bug 609572 - Event Emitter needs it's "private" APIs documented r=erikvold(cherry picked from commit 1f3fef7651a533cfcc95cd9fa2c9823d5c7088d7)