summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Dang <me@bdang.it>2018-04-13 10:54:05 -0700
committerGitHub <noreply@github.com>2018-04-13 10:54:05 -0700
commit836c4f29a585e4b176738f64cf8d312171be5fe0 (patch)
tree03b24055b97e9f4a053fc0cb6bcb4662c1c7a768
parente47d0d1c5142a4ad1203e58db31af2f58bafcda9 (diff)
downloadgperftools-836c4f29a585e4b176738f64cf8d312171be5fe0.tar.gz
Update documentation for heap_checker.html
Make it clear that the static methods used require the "namespace", `HeapLeakChecker::`.
-rw-r--r--docs/heap_checker.html6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/heap_checker.html b/docs/heap_checker.html
index ea2ade6..ca05b50 100644
--- a/docs/heap_checker.html
+++ b/docs/heap_checker.html
@@ -138,7 +138,7 @@ but waiting for after <code>main()</code> exits to do the first
whole-program leak check is waiting too long: e.g. in a long-running
server one might wish to simply periodically check for leaks while the
server is running. In this case, you can call the static method
-<code>NoGlobalLeaks()</code>, to verify no global leaks have happened
+<code>HeapLeakChecker::NoGlobalLeaks()</code>, to verify no global leaks have happened
as of that point in the program.</p>
<p>Alternately, doing the check after <code>main()</code> exits might
@@ -146,8 +146,8 @@ be too late. Perhaps you have some objects that are known not to
clean up properly at exit. You'd like to do the "at exit" check
before those objects are destroyed (since while they're live, any
memory they point to will not be considered a leak). In that case,
-you can call <code>NoGlobalLeaks()</code> manually, near the end of
-<code>main()</code>, and then call <code>CancelGlobalCheck()</code> to
+you can call <code>HeapLeakChecker::NoGlobalLeaks()</code> manually, near the end of
+<code>main()</code>, and then call <code>HeapLeakChecker::CancelGlobalCheck()</code> to
turn off the automatic post-<code>main()</code> check.</p>
<p>Finally, there's a helper macro for "strict" and "draconian" modes,