diff --git a/lib/common_test/doc/src/ct_suite.xml b/lib/common_test/doc/src/ct_suite.xml
index dfabcb525960..c2034239b28e 100644
--- a/lib/common_test/doc/src/ct_suite.xml
+++ b/lib/common_test/doc/src/ct_suite.xml
@@ -84,15 +84,7 @@
Returns the list of all test case groups and test cases
in the module.
- TestDef = TestCase | {group, GroupName} | {group, GroupName, Properties} | {group, GroupName, Properties, SubGroups}
- TestCase = atom()
- GroupName = atom()
- Properties = [parallel | sequence | Shuffle | {RepeatType, N}] | default
- SubGroups = [{GroupName, Properties} | {GroupName, Properties, SubGroups}]
- Shuffle = shuffle | {shuffle, Seed}
- Seed = {integer(), integer(), integer()}
- RepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail | repeat_until_any_ok | repeat_until_any_fail
- N = integer() | forever
+ TestDef = ct_test_def()
Reason = term()
@@ -130,15 +122,7 @@
Module:groups() -> [GroupDef]
Returns a list of test case group definitions.
- GroupDef = {GroupName, Properties, GroupsAndTestCases}
- GroupName = atom()
- Properties = [parallel | sequence | Shuffle | {RepeatType, N}]
- GroupsAndTestCases = [Group | {group, GroupName} | TestCase]
- TestCase = atom()
- Shuffle = shuffle | {shuffle, Seed}
- Seed = {integer(), integer(), integer()}
- RepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail | repeat_until_any_ok | repeat_until_any_fail
- N = integer() | forever
+ GroupDef = ct_group_def()
@@ -155,29 +139,7 @@
Test suite info function (providing default data
for the suite).
- Info = {timetrap, Time} | {require, Required} | {require, Name, Required} | {userdata, UserData} | {silent_connections, Conns} | {stylesheet, CSSFile} | {ct_hooks, CTHs}
- Time = TimeVal | TimeFunc
- TimeVal = MilliSec | {seconds, integer()} | {minutes, integer()} | {hours, integer()}
- TimeFunc = {Mod, Func, Args} | Fun
- MilliSec = integer()
- Mod = atom()
- Func = atom()
- Args = list()
- Fun = fun()
- Required = Key | {Key, SubKeys} | {Key, SubKey} | {Key, SubKey, SubKeys}
- Key = atom()
- SubKeys = SubKey | [SubKey]
- SubKey = atom()
- Name = atom()
- UserData = term()
- Conns = [atom()]
- CSSFile = string()
- CTHs = [CTHModule |
- {CTHModule, CTHInitArgs} |
- {CTHModule, CTHInitArgs, CTHPriority}]
- CTHModule = atom()
- CTHInitArgs = term()
- CTHPriority = integer()
+ Info = ct_info()
@@ -229,9 +191,7 @@
{skip_and_save, Reason, SaveConfig}
Test suite initializations.
- Config = NewConfig = SaveConfig = [{Key, Value}]
- Key = atom()
- Value = term()
+ Config = NewConfig = SaveConfig = ct_config()
Reason = term()
@@ -264,9 +224,7 @@
{save_config, SaveConfig}
Test suite finalization.
- Config = SaveConfig = [{Key, Value}]
- Key = atom()
- Value = term()
+ Config = SaveConfig = ct_config()
@@ -289,30 +247,8 @@
for a test case group, that is, its test cases and
subgroups).
- GroupName = atom()
- Info = {timetrap, Time} | {require, Required} | {require, Name, Required} | {userdata, UserData} | {silent_connections, Conns} | {stylesheet, CSSFile} | {ct_hooks, CTHs}
- Time = TimeVal | TimeFunc
- TimeVal = MilliSec | {seconds, integer()} | {minutes, integer()} | {hours, integer()}
- TimeFunc = {Mod, Func, Args} | Fun
- MilliSec = integer()
- Mod = atom()
- Func = atom()
- Args = list()
- Fun = fun()
- Required = Key | {Key, SubKeys} | {Key, SubKey} | {Key, SubKey, SubKeys}
- Key = atom()
- SubKeys = SubKey | [SubKey]
- SubKey = atom()
- Name = atom()
- UserData = term()
- Conns = [atom()]
- CSSFile = string()
- CTHs = [CTHModule |
- {CTHModule, CTHInitArgs} |
- {CTHModule, CTHInitArgs, CTHPriority}]
- CTHModule = atom()
- CTHInitArgs = term()
- CTHPriority = integer()
+ GroupName = ct_groupname()
+ Info = ct_info()
@@ -370,10 +306,8 @@
{skip, Reason}
Test case group initializations.
- GroupName = atom()
- Config = NewConfig = [{Key, Value}]
- Key = atom()
- Value = term()
+ GroupName = ct_groupname()
+ Config = NewConfig = ct_config()
Reason = term()
@@ -408,11 +342,9 @@
{return_group_result, Status}
Test case group finalization.
- GroupName = atom()
- Config = [{Key, Value}]
- Key = atom()
- Value = term()
- Status = ok | skipped | failed
+ GroupName = ct_groupname()
+ Config = ct_config()
+ Status = ct_status()
@@ -441,10 +373,8 @@
Module:init_per_testcase(TestCase, Config) -> NewConfig | {fail, Reason} | {skip, Reason}
Test case initializations.
- TestCase = atom()
- Config = NewConfig = [{Key, Value}]
- Key = atom()
- Value = term()
+ TestCase = ct_testname()
+ Config = NewConfig = ct_config()
Reason = term()
@@ -471,10 +401,8 @@
Module:end_per_testcase(TestCase, Config) -> term() | {fail, Reason} | {save_config, SaveConfig}
Test case finalization.
- TestCase = atom()
- Config = SaveConfig = [{Key, Value}]
- Key = atom()
- Value = term()
+ TestCase = ct_testname()
+ Config = SaveConfig = ct_config()
Reason = term()
@@ -577,9 +505,7 @@
Module:Testcase(Config) -> term() | {skip, Reason} | {comment, Comment} | {save_config, SaveConfig} | {skip_and_save, Reason, SaveConfig} | exit()
A test case.
- Config = SaveConfig = [{Key, Value}]
- Key = atom()
- Value = term()
+ Config = SaveConfig = ct_config()
Reason = term()
Comment = string()