Closed Bug 904716 Opened 7 years ago Closed 5 months ago

Updates needed for debugger docs

Categories

(DevTools :: Debugger, task, P5)

task

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: bbenvie, Unassigned)

References

(Blocks 1 open bug)

Details

(Whiteboard: [debugger-docs-needed])

I just did an inventory comparing what's actually implemented to what DebuggerDocs claims. There's a handful of undocumented things, a number of things that are unimplemented but not noted as so, and one discrepancy. We should try to keep the docs as close as possible to the implementation.

Debugger
undocumented
* removeAllDebuggees
* addAllGlobalsAsDebuggees
unimplemented
* onThrow
* onError
* findScriptURLs
* clearBreakpoint
* clearAllWatchpoints


Debugger.Frame
unimplemented
* onResume
* get depth
* pop
* replaceCall


Debugger.Script
undocumented
* get source
* get sourceStart
* get sourceLength
unimplemented
* get strictMode
* decompile
discrepencies
* clearBreakpoint <-> clearBreakpoints


Debugger.Object
unimplemented
* get proxyHandler
* get proxyCallTrap
* get proxyConstructTrap
* get hostAnnotations
* getProperty
* setProperty
* copy
* create
* decompile
* asEnvironment
* setObjectWatchpoint
* clearObjectWatchpoint
* setPropertyWatchPoint
* clearPropertyWatchpoint
Whiteboard: [debugger-docs-needed]
Wow, thanks for the audit! This is really helpful.

I can't get to this today. :( But I will go after it as soon as I can.
Priority: -- → P3
Summary: Updates needed for DebuggerDocs → Updates needed for debugger docs
Unfortunately, the docs are still claiming support for features that weren't implemented - I wasted quite a bit of time on this. It would already help if the docs in MDN reflected the latest state of the documentation in the source code.
Severity: normal → enhancement
Product: Firefox → DevTools
Type: enhancement → task
Priority: P3 → P5
Blocks: dbg-api

I'm not aware of any remaining documented but non-existant methods, so going to close.

Status: NEW → RESOLVED
Closed: 5 months ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.