Open Bug 1070270 Opened 5 years ago Updated 2 years ago

protocol.js method descriptions should include a documentation string

Categories

(DevTools :: General, defect)

x86
macOS
defect
Not set

Tracking

(Not tracked)

People

(Reporter: wbamberg, Unassigned)

References

(Blocks 1 open bug)

Details

It's apparently possible to get a JSON description of the protocol for actors that are created using protocol.js. Like this: http://mxr.mozilla.org/mozilla-central/source/addon-sdk/source/lib/dev/volcan.js#868. This is what's used in volcan.js to generate JS APIs, for people to use the Firefox debugger server. We might be able to use this JSON to build API reference documentation for these APIs.

Many of the actor implementations already include good in-source documentation (random example: http://mxr.mozilla.org/mozilla-central/source/toolkit/devtools/server/actors/highlighter.js#113). If the protocol.js method description could include documentation strings, then we could include that documentation in the API reference documentation too.
Product: Firefox → DevTools
You need to log in before you can comment on or make changes to this bug.