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/ct.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/ct.erl')
-rw-r--r-- | lib/common_test/src/ct.erl | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/lib/common_test/src/ct.erl b/lib/common_test/src/ct.erl index 43abb91819..662732d475 100644 --- a/lib/common_test/src/ct.erl +++ b/lib/common_test/src/ct.erl @@ -89,6 +89,36 @@ -export([get_target_name/1]). -export([parse_table/1, listenv/1]). +%%---------------------------------------------------------------------- +%% Exported types +%%---------------------------------------------------------------------- +%% For ct_gen_conn +-export_type([config_key/0, + target_name/0, + key_or_name/0]). + +%% For cth_conn_log +-export_type([conn_log_options/0, + conn_log_type/0, + conn_log_mod/0]). + +%%------------------------------------------------------------------ +%% Type declarations +%% ------------------------------------------------------------------ +-type config_key() :: atom(). % Config key which exists in a config file +-type target_name() :: atom().% Name associated to a config_key() though 'require' +-type key_or_name() :: config_key() | target_name(). + +%% Types used when logging connections with the 'cth_conn_log' hook +-type conn_log_options() :: [conn_log_option()]. +-type conn_log_option() :: {log_type,conn_log_type()} | + {hosts,[key_or_name()]}. +-type conn_log_type() :: raw | pretty | html | silent. +-type conn_log_mod() :: ct_netconfc | ct_telnet. +%%---------------------------------------------------------------------- + + + %%%----------------------------------------------------------------- %%% @spec install(Opts) -> ok | {error,Reason} %%% Opts = [Opt] |