From c2a3647e471bb08de24d867bc7c3f541e2f7a15d Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Tue, 20 Mar 2012 01:29:02 +0100
Subject: Implement support for user controlled timetraps

OTP-9988
---
 lib/common_test/src/ct.erl | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

(limited to 'lib/common_test/src/ct.erl')

diff --git a/lib/common_test/src/ct.erl b/lib/common_test/src/ct.erl
index 63a8adbc63..296416737f 100644
--- a/lib/common_test/src/ct.erl
+++ b/lib/common_test/src/ct.erl
@@ -993,13 +993,21 @@ remove_config(Callback, Config) ->
 
 %%%-----------------------------------------------------------------
 %%% @spec timetrap(Time) -> ok
-%%%       Time = {hours,Hours} | {minutes,Mins} | {seconds,Secs} | Millisecs | infinity
+%%%       Time = {hours,Hours} | {minutes,Mins} | {seconds,Secs} | Millisecs | infinity | Func
 %%%       Hours = integer()
 %%%       Mins = integer()
 %%%       Secs = integer()
 %%%       Millisecs = integer() | float()
-%%%
-%%% @doc <p>Use this function to set a new timetrap for the running test case.</p>
+%%%       Func = {M,F,A} | fun()
+%%%       M = atom()
+%%%       F = atom()
+%%%       A = list()
+%%%
+%%% @doc <p>Use this function to set a new timetrap for the running test case.
+%%%      If the argument is <code>Func</code>, the timetrap will be triggered
+%%%      when this function returns. <code>Func</code> may also return a new
+%%%      <code>Time</code> value, which in that case will be the value for the
+%%%      new timetrap.</p>
 timetrap(Time) ->
     test_server:timetrap_cancel(),
     test_server:timetrap(Time).
-- 
cgit v1.2.3