From 2cca6506bafedc5ebb720510151a98602133d8e5 Mon Sep 17 00:00:00 2001
From: Christopher Faulet <christopher.faulet@capflam.org>
Date: Tue, 6 Apr 2010 22:39:14 +0200
Subject: Add timer:tc/2 to measure the elapsed time of anonymous functions

Works like timer:tc/3 but for anonymous functions.
---
 lib/stdlib/doc/src/timer.xml | 24 +++++++++++++++++++-----
 1 file changed, 19 insertions(+), 5 deletions(-)

(limited to 'lib/stdlib/doc')

diff --git a/lib/stdlib/doc/src/timer.xml b/lib/stdlib/doc/src/timer.xml
index 0b6807dd6c..3d54047e35 100644
--- a/lib/stdlib/doc/src/timer.xml
+++ b/lib/stdlib/doc/src/timer.xml
@@ -202,18 +202,32 @@
     </func>
     <func>
       <name>tc(Module, Function, Arguments) -> {Time, Value}</name>
-      <fsummary>Measure the real time it takes to evaluate <c>apply(Module, Function, Arguments)</c></fsummary>
+      <name>tc(Fun, Arguments) -> {Time, Value}</name>
+      <fsummary>Measure the real time it takes to evaluate <c>apply(Module,
+      Function, Arguments)</c> or <c>apply(Fun, Arguments)</c></fsummary>
       <type>
         <v>Module = Function = atom()</v>
+        <v>Fun = fun()</v>
         <v>Arguments = [term()]</v>
         <v>Time = integer() in microseconds</v>
         <v>Value = term()</v>
       </type>
       <desc>
-        <p>Evaluates <c>apply(Module, Function, Arguments)</c> and measures
-          the elapsed real time. Returns <c>{Time, Value}</c>, where 
-          <c>Time</c> is the elapsed real time in <em>microseconds</em>,
-          and <c>Value</c> is what is returned from the apply.</p>
+        <p></p>
+        <taglist>
+          <tag><c>tc/3</c></tag>
+          <item>
+            <p>Evaluates <c>apply(Module, Function, Arguments)</c> and measures
+              the elapsed real time. Returns <c>{Time, Value}</c>, where
+              <c>Time</c> is the elapsed real time in <em>microseconds</em>,
+              and <c>Value</c> is what is returned from the apply.</p>
+          </item>
+          <tag><c>tc/2</c></tag>
+          <item>
+            <p>Evaluates <c>apply(Fun, Arguments)</c>. Otherwise works
+            like <c>tc/3</c>.</p>
+          </item>
+        </taglist>
       </desc>
     </func>
     <func>
-- 
cgit v1.2.3