aboutsummaryrefslogtreecommitdiffstats
path: root/lib/common_test/doc/src/common_test_app.xml
diff options
context:
space:
mode:
authorLukas Larsson <[email protected]>2011-02-09 16:54:20 +0100
committerLukas Larsson <[email protected]>2011-02-17 16:59:27 +0100
commit15e8dd20b5ba2c82e683e87254f18c9af3625481 (patch)
tree3ea321b2a1a4aeacb99d7e17efd7fb303f254dc5 /lib/common_test/doc/src/common_test_app.xml
parent3163804a22daa8e123078291496778963e16f7fe (diff)
downloadotp-15e8dd20b5ba2c82e683e87254f18c9af3625481.tar.gz
otp-15e8dd20b5ba2c82e683e87254f18c9af3625481.tar.bz2
otp-15e8dd20b5ba2c82e683e87254f18c9af3625481.zip
Add documentation for SCBs
Diffstat (limited to 'lib/common_test/doc/src/common_test_app.xml')
-rw-r--r--lib/common_test/doc/src/common_test_app.xml10
1 files changed, 9 insertions, 1 deletions
diff --git a/lib/common_test/doc/src/common_test_app.xml b/lib/common_test/doc/src/common_test_app.xml
index e30eef2488..a735dc85a8 100644
--- a/lib/common_test/doc/src/common_test_app.xml
+++ b/lib/common_test/doc/src/common_test_app.xml
@@ -131,7 +131,8 @@
<type>
<v> Info = {timetrap,Time} | {require,Required} |
{require,Name,Required} | {userdata,UserData} |
- {silent_connections,Conns} | {stylesheet,CSSFile}</v>
+ {silent_connections,Conns} | {stylesheet,CSSFile} |
+ {suite_callbacks, SCBs}</v>
<v> Time = MilliSec | {seconds,integer()} | {minutes,integer()}
| {hours,integer()}</v>
<v> MilliSec = integer()</v>
@@ -143,6 +144,9 @@
<v> UserData = term()</v>
<v> Conns = [atom()]</v>
<v> CSSFile = string()</v>
+ <v> SCBs = [SCBModule | {SCBModule, SCBInitArgs}]</v>
+ <v> SCBModule = atom()</v>
+ <v> SCBInitArgs = term()</v>
</type>
<desc>
@@ -170,6 +174,10 @@
<p>With <c>userdata</c>, it is possible for the user to
specify arbitrary test suite related information which can be
read by calling <c>ct:userdata/2</c>.</p>
+
+ <p>The <c>suite_callbacks</c> tag specifies which
+ <seealso marker="suite_callbacks_chapter">Suite Callbacks</seealso>
+ are to be run together with this suite.</p>
<p>Other tuples than the ones defined will simply be ignored.</p>