Bug 993522 - fix comment in DMD.h; r=njn
authorNathan Froyd <froydnj@mozilla.com>
Tue, 08 Apr 2014 13:07:46 -0400
changeset 197665 5d5dae8097ef84b87e3f4214b70108bf5f81c94f
parent 197664 5c509bb6f5c4d0fba0c0f718538443e158043ec0
child 197666 2c59614ef6d351e08a9483685ccdcf67f139f95b
push id3624
push userasasaki@mozilla.com
push dateMon, 09 Jun 2014 21:49:01 +0000
treeherdermozilla-beta@b1a5da15899a [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersnjn
bugs993522
milestone31.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 993522 - fix comment in DMD.h; r=njn
memory/replace/dmd/DMD.h
--- a/memory/replace/dmd/DMD.h
+++ b/memory/replace/dmd/DMD.h
@@ -50,17 +50,20 @@ ClearReports();
 
 // Checks which heap blocks have been reported, and dumps a human-readable
 // summary (via |aWrite|).  If |aWrite| is nullptr it will dump to stderr.
 // Beware:  this output may have very long lines.
 MOZ_EXPORT void
 Dump(Writer aWriter);
 
 // A useful |WriterFun|.  If |fp| is a FILE* you want |Dump|'s output to be
-// written to, call |Dump(FpWrite, fp)|.
+// written to, call:
+//
+//   dmd::Writer writer(FpWrite, fp);
+//   dmd::Dump(writer);
 MOZ_EXPORT void
 FpWrite(void* aFp, const char* aFmt, va_list aAp);
 
 struct Sizes
 {
   size_t mStackTracesUsed;
   size_t mStackTracesUnused;
   size_t mStackTraceTable;