diff options
| author | Siri Hansen <[email protected]> | 2017-05-04 17:28:01 +0200 |
|---|---|---|
| committer | Siri Hansen <[email protected]> | 2017-05-08 15:37:19 +0200 |
| commit | fe521f4679ed0caa068f3825869796001b29fc40 (patch) | |
| tree | e8dba43d70223e63f3ac46212db2fdb0515cb244 /lib/common_test/src/cth_conn_log.erl | |
| parent | 63d63920f3f68f1d3cc62184e9f1a5c51da17088 (diff) | |
| download | otp-fe521f4679ed0caa068f3825869796001b29fc40.tar.gz otp-fe521f4679ed0caa068f3825869796001b29fc40.tar.bz2 otp-fe521f4679ed0caa068f3825869796001b29fc40.zip | |
[ct_netconfc] Update documentation
* Remove edoc comments in ct_netconfc.erl
* Rewrite ct_netconfc.xml to use specs for functions and types
* Add documentation of new functions in ct_netconfc
Diffstat (limited to 'lib/common_test/src/cth_conn_log.erl')
| -rw-r--r-- | lib/common_test/src/cth_conn_log.erl | 19 |
1 files changed, 4 insertions, 15 deletions
diff --git a/lib/common_test/src/cth_conn_log.erl b/lib/common_test/src/cth_conn_log.erl index a37cc76d32..faff150ac9 100644 --- a/lib/common_test/src/cth_conn_log.erl +++ b/lib/common_test/src/cth_conn_log.erl @@ -58,28 +58,17 @@ post_end_per_testcase/5]). %%---------------------------------------------------------------------- -%% Exported types -%%---------------------------------------------------------------------- --export_type([hook_options/0, - log_type/0, - conn_mod/0]). - -%%---------------------------------------------------------------------- %% Type declarations %%---------------------------------------------------------------------- --type hook_options() :: [hook_option()]. -%% Options that can be given to `cth_conn_log' in the `ct_hook' statement. --type hook_option() :: {log_type,log_type()} | - {hosts,[ct_gen_conn:key_or_name()]}. --type log_type() :: raw | pretty | html | silent. --type conn_mod() :: ct_netconfc | ct_telnet. +-type hook_options() :: ct:conn_log_options(). +-type log_type() :: ct:conn_log_type(). +-type conn_mod() :: ct:conn_log_mod(). %%---------------------------------------------------------------------- -spec init(Id, HookOpts) -> Result when Id :: term(), HookOpts :: hook_options(), - Result :: {ok,[{conn_mod(), - {log_type(),[ct_gen_conn:key_or_name()]}}]}. + Result :: {ok,[{conn_mod(),{log_type(),[ct:key_or_name()]}}]}. init(_Id, HookOpts) -> ConfOpts = ct:get_config(ct_conn_log,[]), {ok,merge_log_info(ConfOpts,HookOpts)}. |