Bug 1132474 - Further clarify restrictions of TabTarget's actor description methods in the comments. r=jryans

This commit is contained in:
Jordan Santell 2015-02-23 10:46:00 +01:00
parent 232bf999d9
commit 087c992c56

View File

@ -184,7 +184,13 @@ TabTarget.prototype = {
* Returns a promise for the protocol description from the root actor.
* Used internally with `target.actorHasMethod`. Takes advantage of
* caching if definition was fetched previously with the corresponding
* actor information. Must be a remote target.
* actor information. Actors are lazily loaded, so not only must the tool using
* a specific actor be in use, the actors are only registered after invoking
* a method (for performance reasons, added in bug 988237), so to use these actor
* detection methods, one must already be communicating with a specific actor of
* that type.
*
* Must be a remote target.
*
* @return {Promise}
* {
@ -250,7 +256,8 @@ TabTarget.prototype = {
/**
* Queries the protocol description to see if an actor has
* an available method. The actor must already be lazily-loaded,
* an available method. The actor must already be lazily-loaded (read
* the restrictions in the `getActorDescription` comments),
* so this is for use inside of tool. Returns a promise that
* resolves to a boolean. Must be a remote target.
*