Bug 1055206: Document meaning of `null` entries in drainAllocationsLog result. r=fitzgen
authorJim Blandy <jimb@mozilla.com>
Tue, 19 Aug 2014 15:55:32 -0700
changeset 214797 c181933a82736758370afcea2a5a733b223688ab
parent 214796 35c265c62076dec4ebb88d5ca34525a958617bd8
child 214798 28ccb18dc241c697fe7d995fff6174081b93e2b4
push idunknown
push userunknown
push dateunknown
reviewersfitzgen
bugs1055206
milestone34.0a1
Bug 1055206: Document meaning of `null` entries in drainAllocationsLog result. r=fitzgen
js/src/doc/Debugger/Debugger.Memory.md
--- a/js/src/doc/Debugger/Debugger.Memory.md
+++ b/js/src/doc/Debugger/Debugger.Memory.md
@@ -87,17 +87,18 @@ following accessor properties from its p
 
 
 Function Properties of the `Debugger.Memory.prototype` Object
 -------------------------------------------------------------
 
 <code id='drain-alloc-log'>drainAllocationsLog()</code>
 :   When `trackingAllocationSites` is `true`, this method returns an array of
     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
     call to `drainAllocationsLog`. Therefore, calling this method effectively
     clears the log.
 
     When `trackingAllocationSites` is `false`, `drainAllocationsLog()` throws an
     `Error`.
 
 <code id='take-census'>takeCensus()</code>