common_test: Remove EDoc comments in internal modules

2 files changed, 27 insertions, 37 deletions

diff --git a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/ct_scope_per_tc_cth_SUITE.erl b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/ct_scope_per_tc_cth_SUITE.erl
index d400348354..404fb33476 100644
--- a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/ct_scope_per_tc_cth_SUITE.erl
+++ b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/ct_scope_per_tc_cth_SUITE.erl
@@ -1,7 +1,7 @@
 %%

 %% %CopyrightBegin%

 %%

-%% Copyright Ericsson AB 2010-2016. All Rights Reserved.

+%% Copyright Ericsson AB 2010-2018. All Rights Reserved.

 %%

 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -29,7 +29,6 @@
 

 %% Test server callback functions

 %%--------------------------------------------------------------------

-%% @doc

 %% Config - [tuple()]

 %%   A list of key/value pairs, holding the test case configuration.

 %%

@@ -38,27 +37,23 @@
 %% Note: This function is free to add any key/value pairs to the Config

 %% variable, but should NOT alter/remove any existing entries.

 %%

-%% @spec init_per_suite(Config) -> Config

-%% @end

+%% -spec init_per_suite(Config) -> Config

 %%--------------------------------------------------------------------

 init_per_suite(Config) ->

     Config.

 

 %%--------------------------------------------------------------------

-%% @doc

 %% Config - [tuple()]

 %%   A list of key/value pairs, holding the test case configuration.

 %%

 %% Cleanup after the whole suite

 %%

-%% @spec end_per_suite(Config) -> _

-%% @end

+%% -spec end_per_suite(Config) -> _

 %%--------------------------------------------------------------------

 end_per_suite(_Config) ->

     ok.

 

 %%--------------------------------------------------------------------

-%% @doc

 %% Case - atom()

 %%   Name of the test case that is about to be run.

 %% Config - [tuple()]

@@ -70,14 +65,12 @@ end_per_suite(_Config) ->
 %% variable, but should NOT alter/remove any existing entries.

 %% Initiation before each test case

 %%

-%% @spec init_per_testcase(TestCase, Config) -> Config

-%% @end

+%% -spec init_per_testcase(TestCase, Config) -> Config

 %%--------------------------------------------------------------------

 init_per_testcase(_TestCase, Config) ->

     [{ct_hooks,[empty_cth]}|Config].

 

 %%--------------------------------------------------------------------

-%% @doc

 %% Case - atom()

 %%   Name of the test case that is about to be run.

 %% Config - [tuple()]

@@ -85,22 +78,19 @@ init_per_testcase(_TestCase, Config) ->
 %%

 %% Cleanup after each test case

 %%

-%% @spec end_per_testcase(TestCase, Config) -> _

-%% @end

+%% -spec end_per_testcase(TestCase, Config) -> _

 %%--------------------------------------------------------------------

 end_per_testcase(_TestCase, _Config) ->

     ok.

 

 %%--------------------------------------------------------------------

-%% @doc

 %% TestCases - [Case]

 %% Case - atom()

 %%   Name of a test case.

 %%

 %% Returns a list of all test cases in this test suite

 %%

-%% @spec all() -> TestCases

-%% @end

+%% -spec all() -> TestCases

 %%--------------------------------------------------------------------

 all() ->

     [test_case].

diff --git a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl
index 961ea68d2d..c648367838 100644
--- a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl
+++ b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2010-2017. All Rights Reserved.
+%% Copyright Ericsson AB 2010-2018. All Rights Reserved.
 %%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -18,9 +18,9 @@
 %% %CopyrightEnd%
 %%
 
-%%% @doc Common Test Example Suite Callback module.
+%%% Common Test Example Suite Callback module.
 %%%
-%%% <p>This module gives an example of a common test CTH (Common Test Hook).
+%%% This module gives an example of a common test CTH (Common Test Hook).
 %%% There are many ways to add a CTH to a test run, you can do it either in
 %%% the command line using -ct_hook, in a test spec using
 %%% {ct_hook,M} or in the suite it self by returning ct_hook
@@ -31,7 +31,7 @@
 %%% it will be stopped after end_per_suite and so on. See terminate
 %%% documentation for a table describing the scoping machanics. 
 %%%
-%%% All of callbacks except init/1 in a CTH are optional.</p>
+%%% All of callbacks except init/1 in a CTH are optional.
 
 -module(empty_cth).
 
@@ -71,7 +71,7 @@
 
 -record(state, { id = ?MODULE :: term()}).
 
-%% @doc Always called before any other callback function. Use this to initiate
+%% Always called before any other callback function. Use this to initiate
 %% any common state. It should return an state for this CTH.
 -spec init(Id :: term(), Opts :: proplists:proplist()) ->
     {ok, State :: #state{}}.
@@ -81,7 +81,7 @@ init(Id, Opts) ->
     ct:log("~w:init called", [?MODULE]),
     {ok,Opts}.
 
-%% @doc The ID is used to uniquly identify an CTH instance, if two CTH's 
+%% The ID is used to uniquly identify an CTH instance, if two CTH's
 %% return the same ID the seconds CTH is ignored. This function should NOT 
 %% have any side effects as it might be called multiple times by common test.
 -spec id(Opts :: proplists:proplist()) ->
@@ -92,7 +92,7 @@ id(Opts) ->
     ct:log("~w:id called", [?MODULE]),
     ct_test_support:unique_timestamp().
 
-%% @doc Called before init_per_suite is called. Note that this callback is
+%% Called before init_per_suite is called. Note that this callback is
 %% only called if the CTH is added before init_per_suite is run (eg. in a test
 %% specification, suite/0 function etc).
 %% You can change the config in the this function.
@@ -108,7 +108,7 @@ pre_init_per_suite(Suite,Config,State) ->
     ct:log("~w:pre_init_per_suite(~w) called", [?MODULE,Suite]),
     {Config, State}.
 
-%% @doc Called after init_per_suite.
+%% Called after init_per_suite.
 %% you can change the return value in this function.
 -spec post_init_per_suite(Suite :: atom(),
 			  Config :: config(),
@@ -123,7 +123,7 @@ post_init_per_suite(Suite,Config,Return,State) ->
     ct:log("~w:post_init_per_suite(~w) called", [?MODULE,Suite]),
     {Return, State}.
 
-%% @doc Called before end_per_suite. The config/state can be changed here,
+%% Called before end_per_suite. The config/state can be changed here,
 %% though it will only affect the *end_per_suite function.
 -spec pre_end_per_suite(Suite :: atom(),
 		    Config :: config() | skip_or_fail(),
@@ -137,7 +137,7 @@ pre_end_per_suite(Suite,Config,State) ->
     ct:log("~w:pre_end_per_suite(~w) called", [?MODULE,Suite]),
     {Config, State}.
 
-%% @doc Called after end_per_suite. Note that the config cannot be
+%% Called after end_per_suite. Note that the config cannot be
 %% changed here, only the status of the suite.
 -spec post_end_per_suite(Suite :: atom(),
 			 Config :: config(),
@@ -152,7 +152,7 @@ post_end_per_suite(Suite,Config,Return,State) ->
     ct:log("~w:post_end_per_suite(~w) called", [?MODULE,Suite]),
     {Return, State}.
 
-%% @doc Called before each init_per_group.
+%% Called before each init_per_group.
 %% You can change the config in this function.
 -spec pre_init_per_group(Suite :: atom(),
                          Group :: atom(),
@@ -167,7 +167,7 @@ pre_init_per_group(Suite,Group,Config,State) ->
     ct:log("~w:pre_init_per_group(~w,~w) called", [?MODULE,Suite,Group]),
     {Config, State}.
 
-%% @doc Called after each init_per_group.
+%% Called after each init_per_group.
 %% You can change the return value in this function.
 -spec post_init_per_group(Suite :: atom(),
                           Group :: atom(),
@@ -183,7 +183,7 @@ post_init_per_group(Suite,Group,Config,Return,State) ->
     ct:log("~w:post_init_per_group(~w,~w) called", [?MODULE,Suite,Group]),
     {Return, State}.
 
-%% @doc Called after each end_per_group. The config/state can be changed here,
+%% Called after each end_per_group. The config/state can be changed here,
 %% though it will only affect the *end_per_group functions.
 -spec pre_end_per_group(Suite :: atom(),
                         Group :: atom(),
@@ -198,7 +198,7 @@ pre_end_per_group(Suite,Group,Config,State) ->
     ct:log("~w:pre_end_per_group(~w~w) called", [?MODULE,Suite,Group]),
     {Config, State}.
 
-%% @doc Called after each end_per_group. Note that the config cannot be
+%% Called after each end_per_group. Note that the config cannot be
 %% changed here, only the status of the group.
 -spec post_end_per_group(Suite :: atom(),
                          Group :: atom(),
@@ -214,7 +214,7 @@ post_end_per_group(Suite,Group,Config,Return,State) ->
     ct:log("~w:post_end_per_group(~w,~w) called", [?MODULE,Suite,Group]),
     {Return, State}.
 
-%% @doc Called before init_per_testcase/2 for each test case.
+%% Called before init_per_testcase/2 for each test case.
 %% You can change the config in this function.
 -spec pre_init_per_testcase(Suite :: atom(),
                             TC :: atom(),
@@ -229,7 +229,7 @@ pre_init_per_testcase(Suite,TC,Config,State) ->
     ct:log("~w:pre_init_per_testcase(~w,~w) called", [?MODULE,Suite,TC]),
     {Config, State}.
 
-%% @doc Called after init_per_testcase/2, and before the test case.
+%% Called after init_per_testcase/2, and before the test case.
 -spec post_init_per_testcase(Suite :: atom(),
                              TC :: atom(),
 			     Config :: config(),
@@ -244,7 +244,7 @@ post_init_per_testcase(Suite,TC,Config,Return,State) ->
     ct:log("~w:post_init_per_testcase(~w,~w) called", [?MODULE,Suite,TC]),
     {Return, State}.
 
-%% @doc Called before end_per_testacse/2. No skip or fail allowed here,
+%% Called before end_per_testacse/2. No skip or fail allowed here,
 %% only config additions.
 -spec pre_end_per_testcase(Suite :: atom(),
                            TC :: atom(),
@@ -259,7 +259,7 @@ pre_end_per_testcase(Suite,TC,Config,State) ->
     ct:log("~w:pre_end_per_testcase(~w,~w) called", [?MODULE,Suite,TC]),
     {Config, State}.
 
-%% @doc Called after end_per_testcase/2 for each test case. Note that
+%% Called after end_per_testcase/2 for each test case. Note that
 %% the config cannot be changed here, only the status of the test case.
 -spec post_end_per_testcase(Suite :: atom(),
                             TC :: atom(),
@@ -275,7 +275,7 @@ post_end_per_testcase(Suite,TC,Config,Return,State) ->
     ct:log("~w:post_end_per_testcase(~w,~w) called", [?MODULE,Suite,TC]),
     {Return, State}.
 
-%% @doc Called after post_init_per_suite, post_end_per_suite, post_init_per_group,
+%% Called after post_init_per_suite, post_end_per_suite, post_init_per_group,
 %% post_end_per_group and post_end_per_tc if the suite, group or test case failed.
 %% This function should be used for extra cleanup which might be needed.
 %% It is not possible to modify the config or the status of the test run.
@@ -292,7 +292,7 @@ on_tc_fail(Suite, TC, Reason, State) ->
     ct:log("~w:on_tc_fail(~w,~w) called", [?MODULE,Suite,TC]),
     State.
 
-%% @doc Called when a test case is skipped by either user action
+%% Called when a test case is skipped by either user action
 %% or due to an init function failing. Test case can be
 %% end_per_suite, init_per_group, end_per_group and the actual test cases. 
 -spec on_tc_skip(Suite :: atom(),
@@ -310,7 +310,7 @@ on_tc_skip(Suite, TC, Reason, State) ->
     ct:log("~w:on_tc_skip(~w,~w) called", [?MODULE,Suite,TC]),
     State.
 
-%% @doc Called when the scope of the CTH is done, this depends on
+%% Called when the scope of the CTH is done, this depends on
 %% when the CTH was specified. This translation table describes when this
 %% function is called.
 %%