diff --git a/test/mtp_prop_gen.erl b/test/mtp_prop_gen.erl index 750f02b..67fd009 100644 --- a/test/mtp_prop_gen.erl +++ b/test/mtp_prop_gen.erl @@ -1,4 +1,4 @@ -%% Common data generators for property-based tests +%% @doc Common data generators for property-based tests -module(mtp_prop_gen). -include_lib("proper/include/proper.hrl"). diff --git a/test/mtp_test_client.erl b/test/mtp_test_client.erl index 4256740..4a3f238 100644 --- a/test/mtp_test_client.erl +++ b/test/mtp_test_client.erl @@ -1,3 +1,4 @@ +%% @doc Simple mtproto proxy client -module(mtp_test_client). -export([connect/5, diff --git a/test/mtp_test_metric.erl b/test/mtp_test_metric.erl index 1881f4d..9d03a41 100644 --- a/test/mtp_test_metric.erl +++ b/test/mtp_test_metric.erl @@ -1,3 +1,5 @@ +%% @doc simple metric backend to be used in tests. +%% XXX: DON'T USE IN PRODUCTION! It can become bottleneck! -module(mtp_test_metric). -behaviour(gen_server). diff --git a/test/mtp_test_middle_server.erl b/test/mtp_test_middle_server.erl index 50bd4a9..40c2967 100644 --- a/test/mtp_test_middle_server.erl +++ b/test/mtp_test_middle_server.erl @@ -1,4 +1,4 @@ -%% Fake telegram "middle-proxy" server +%% @doc Fake telegram "middle-proxy" server -module(mtp_test_middle_server). -behaviour(ranch_protocol). -behaviour(gen_statem). diff --git a/test/prop_mtp_abridged.erl b/test/prop_mtp_abridged.erl index b5b1973..4075ab1 100644 --- a/test/prop_mtp_abridged.erl +++ b/test/prop_mtp_abridged.erl @@ -1,3 +1,4 @@ +%% @doc Property-based tests for mtp_abridged -module(prop_mtp_abridged). -include_lib("proper/include/proper.hrl"). diff --git a/test/prop_mtp_aes_cbc.erl b/test/prop_mtp_aes_cbc.erl index f53f242..2633a0b 100644 --- a/test/prop_mtp_aes_cbc.erl +++ b/test/prop_mtp_aes_cbc.erl @@ -1,3 +1,4 @@ +%% @doc Property-based tests for mtp_aes_cbc -module(prop_mtp_aes_cbc). -include_lib("proper/include/proper.hrl"). diff --git a/test/prop_mtp_full.erl b/test/prop_mtp_full.erl index 77887f1..cc8d62f 100644 --- a/test/prop_mtp_full.erl +++ b/test/prop_mtp_full.erl @@ -1,3 +1,4 @@ +%% @doc property-based tests for mtp_full -module(prop_mtp_full). -include_lib("proper/include/proper.hrl"). diff --git a/test/prop_mtp_intermediate.erl b/test/prop_mtp_intermediate.erl index 82d1ee5..049b7dc 100644 --- a/test/prop_mtp_intermediate.erl +++ b/test/prop_mtp_intermediate.erl @@ -1,3 +1,4 @@ +%% @doc property-based tests for mtp_intermediate -module(prop_mtp_intermediate). -include_lib("proper/include/proper.hrl"). diff --git a/test/prop_mtp_obfuscated.erl b/test/prop_mtp_obfuscated.erl index 4ccba44..716a45b 100644 --- a/test/prop_mtp_obfuscated.erl +++ b/test/prop_mtp_obfuscated.erl @@ -1,3 +1,4 @@ +%% @doc property-based tests for mtp_obfuscated -module(prop_mtp_obfuscated). -include_lib("proper/include/proper.hrl"). diff --git a/test/prop_mtp_rpc.erl b/test/prop_mtp_rpc.erl index 8244142..474a16e 100644 --- a/test/prop_mtp_rpc.erl +++ b/test/prop_mtp_rpc.erl @@ -1,3 +1,4 @@ +%% @doc property-based tests for mtp_rpc -module(prop_mtp_rpc). -include_lib("proper/include/proper.hrl"). @@ -63,7 +64,7 @@ s2c_packet(Packet) -> prop_c2s_packet(doc) -> - "Tests encode/decode of 'proxy_ans'/'close_ext' RPC packets". + "Tests encode/decode of 'data'/'remote_closed' RPC packets". prop_c2s_packet() -> ?FORALL(Packet, c2s_packet_gen(), c2s_packet(Packet)). diff --git a/test/single_dc_SUITE.erl b/test/single_dc_SUITE.erl index 3f1e37a..d85edc5 100644 --- a/test/single_dc_SUITE.erl +++ b/test/single_dc_SUITE.erl @@ -1,4 +1,4 @@ -%% Basic tests with only one telegram DC +%% @doc Basic tests with only one telegram DC -module(single_dc_SUITE). -export([all/0,