Bug 1055206: Document meaning of null entries in drainAllocationsLog result. r=fitzgen

This commit is contained in:
Jim Blandy 2014-08-19 15:55:32 -07:00
parent 05d876dcc4
commit 843828d672

View File

@ -92,7 +92,8 @@ Function Properties of the `Debugger.Memory.prototype` Object
<code id='drain-alloc-log'>drainAllocationsLog()</code> <code id='drain-alloc-log'>drainAllocationsLog()</code>
: When `trackingAllocationSites` is `true`, this method returns an array of : When `trackingAllocationSites` is `true`, this method returns an array of
allocation sites (as [captured stacks][saved-frame]) for recent `Object` allocation sites (as [captured stacks][saved-frame]) for recent `Object`
allocations within the set of debuggees. *Recent* is defined as the allocations within the set of debuggees. Entries for objects allocated with
no JavaScript frames on the stack are `null`. *Recent* is defined as the
`maxAllocationsLogLength` most recent `Object` allocations since the last `maxAllocationsLogLength` most recent `Object` allocations since the last
call to `drainAllocationsLog`. Therefore, calling this method effectively call to `drainAllocationsLog`. Therefore, calling this method effectively
clears the log. clears the log.