Bug 801084: Remove documentation for the unimplemented (and certain to be redesigned) Debugger.Object.prototype.hostAnnotations accessor. DONTBUILD r=jorendorff

This commit is contained in:
Jim Blandy 2014-06-25 22:45:23 -07:00
parent 754bee7342
commit 959dbb448f
2 changed files with 2 additions and 34 deletions

View File

@ -181,34 +181,6 @@ from its prototype:
wrapper's global, not the wrapped object's global. The result refers to
the global directly, not via a wrapper.
`hostAnnotations`
: A JavaScript object providing further metadata about the referent, or
`null` if none is available. The metadata object is in the same
compartment as this `Debugger.Object` instance. The same metadata
object is returned each time for a given `Debugger.Object` instance.
A typical JavaScript embedding provides "host objects" to expose
application-specific functionality to scripts. The `hostAnnotations`
accessor consults the embedding for additional information about the
referent that might be of interest to the debugger. The returned
object's properties' meanings are up to the embedding. For example, a
web browser might provide host annotations for global objects to
distinguish top-level windows, iframes, and internal JavaScript scopes.
By convention, host annotation objects have a string-valued `"type"`
property that, taken together with the object's class, indicate what
sort of thing the referent is. The host annotation object's other
properties provide further details, as appropriate for the type. For
example, in Firefox, a metadata object for a JavaScript Module's global
object might look like this:
```language-js
{ "type":"jsm", "uri":"resource:://gre/modules/XPCOMUtils.jsm" }
```
Firefox provides [DebuggerHostAnnotationsForFirefox annotations] for its
host objects.
## Function Properties of the Debugger.Object prototype

View File

@ -184,9 +184,7 @@ compartment.
This method's return value is ignored.
`onNewGlobalObject(global)`
: A new global object, <i>global</i>, has been created. The application
embedding the JavaScript implementation may provide details about what
kind of global it is via <code><i>global</i>.hostAnnotations</code>.
: A new global object, <i>global</i>, has been created.
This handler method should return a [resumption value][rv] specifying how
the debuggee's execution should proceed. However, note that a <code>{ return:
@ -364,9 +362,7 @@ other kinds of objects.
`findAllGlobals()`
: Return an array of [`Debugger.Object`][object] instances referring to all the
global objects present in this JavaScript instance. The application may
provide details about what kind of globals they are via the
[`Debugger.Object`][object] instances' `hostAnnotations` accessors.
global objects present in this JavaScript instance.
The results of this call can be affected in non-deterministic ways by
the details of the JavaScript implementation. The array may include