syntax_tools: Add types and specs for most exported functions

While at it, consistently replace "bool()" with "boolean()"
in the Edoc specs.

1 files changed, 22 insertions, 10 deletions

diff --git a/lib/syntax_tools/src/erl_tidy.erl b/lib/syntax_tools/src/erl_tidy.erl
index e3b479008f..021ab18736 100644
--- a/lib/syntax_tools/src/erl_tidy.erl
+++ b/lib/syntax_tools/src/erl_tidy.erl
@@ -66,6 +66,7 @@ dir__defaults() ->
 %% @equiv dir("")
 
 -spec dir() -> 'ok'.
+
 dir() ->
     dir("").
 
@@ -74,6 +75,7 @@ dir() ->
 %% @equiv dir(Dir, [])
 
 -spec dir(file:filename()) -> 'ok'.
+
 dir(Dir) ->
     dir(Dir, []).
 
@@ -130,6 +132,7 @@ dir(Dir) ->
 	      options              :: options()}).
 
 -spec dir(file:filename(), options()) -> 'ok'.
+
 dir(Dir, Opts) ->
     Opts1 = Opts ++ dir__defaults(),
     Env = #dir{follow_links = proplists:get_bool(follow_links, Opts1),
@@ -212,6 +215,7 @@ default_printer() ->
 %% @equiv file(Name, [])
 
 -spec file(file:filename()) -> 'ok'.
+
 file(Name) ->
     file(Name, []).
 
@@ -275,6 +279,7 @@ file(Name) ->
 %% @see module/2
 
 -spec file(file:filename(), options()) -> 'ok'.
+
 file(Name, Opts) ->
     Parent = self(),
     Child = spawn_link(fun () -> file_1(Parent, Name, Opts) end),
@@ -478,11 +483,12 @@ backup_file_1(Name, Opts) ->
             throw(R)
     end.
 
-
 %% =====================================================================
 %% @spec module(Forms) -> syntaxTree()
 %% @equiv module(Forms, [])
 
+-spec module(erl_syntax:forms()) -> erl_syntax:syntaxTree().
+
 module(Forms) ->
     module(Forms, []).
 
@@ -609,6 +615,8 @@ module(Forms) ->
 %%
 %% </dl>
 
+-spec module(erl_syntax:forms(), [term()]) -> erl_syntax:syntaxTree().
+
 module(Forms, Opts) when is_list(Forms) ->
     module(erl_syntax:form_list(Forms), Opts);
 module(Forms, Opts) ->
@@ -668,11 +676,8 @@ analyze_forms(Forms, File) ->
             throw(R)
     end.
 
-%% XXX: The following should be imported from erl_syntax_lib
--type key()       :: atom().
--type info_pair() :: {key(), any()}.
+-spec get_module_name([erl_syntax_lib:info_pair()], string()) -> atom().
 
--spec get_module_name([info_pair()], string()) -> atom().
 get_module_name(List, File) ->
     case lists:keyfind(module, 1, List) of
         {module, M} ->
@@ -691,7 +696,8 @@ get_module_attributes(List) ->
             []
     end.
 
--spec get_module_exports([info_pair()]) -> [{atom(), byte()}].
+-spec get_module_exports([erl_syntax_lib:info_pair()]) -> [{atom(), arity()}].
+
 get_module_exports(List) ->
     case lists:keyfind(exports, 1, List) of
         {exports, Es} ->
@@ -700,7 +706,8 @@ get_module_exports(List) ->
             []
     end.
 
--spec get_module_imports([info_pair()]) -> [{atom(), atom()}].
+-spec get_module_imports([erl_syntax_lib:info_pair()]) -> [{atom(), atom()}].
+
 get_module_imports(List) ->
     case lists:keyfind(imports, 1, List) of
         {imports, Is} ->
@@ -714,6 +721,7 @@ compile_attrs(As) ->
                   || {compile, T} <- As]).
 
 -spec flatten_imports([{atom(), [atom()]}]) -> [{atom(), atom()}].
+
 flatten_imports(Is) ->
     [{F, M} || {M, Fs} <- Is, F <- Fs].
 
@@ -736,7 +744,8 @@ check_imports(Is, Opts, File) ->
     end.
 
 -spec check_imports_1([{atom(), atom()}]) -> boolean().
-check_imports_1([{F1, M1}, {F2, M2} | _Is]) when F1 =:= F2, M1 =/= M2 ->
+
+check_imports_1([{F, M1}, {F, M2} | _Is]) when M1 =/= M2 ->
     false;
 check_imports_1([_ | Is]) ->
     check_imports_1(Is);
@@ -1629,6 +1638,7 @@ rename_remote_call(F, St) ->
     end.
 
 -spec rename_remote_call_1(mfa()) -> {atom(), atom()} | 'false'.
+
 rename_remote_call_1({dict, dict_to_list, 1}) -> {dict, to_list};
 rename_remote_call_1({dict, list_to_dict, 1}) -> {dict, from_list};
 rename_remote_call_1({erl_eval, arg_list, 2}) -> {erl_eval, expr_list};
@@ -1662,7 +1672,8 @@ rename_remote_call_1({string, index, 2}) -> {string, str};
 rename_remote_call_1({unix, cmd, 1}) -> {os, cmd};
 rename_remote_call_1(_) -> false.
 
--spec rewrite_guard_test(atom(), byte()) -> atom().
+-spec rewrite_guard_test(atom(), arity()) -> atom().
+
 rewrite_guard_test(atom, 1) -> is_atom;
 rewrite_guard_test(binary, 1) -> is_binary;
 rewrite_guard_test(constant, 1) -> is_constant;
@@ -1680,7 +1691,8 @@ rewrite_guard_test(record, 2) -> is_record;
 rewrite_guard_test(record, 3) -> is_record;
 rewrite_guard_test(N, _A) -> N.
 
--spec reverse_guard_test(atom(), byte()) -> atom().
+-spec reverse_guard_test(atom(), arity()) -> atom().
+
 reverse_guard_test(is_atom, 1) -> atom;
 reverse_guard_test(is_binary, 1) -> binary;
 reverse_guard_test(is_constant, 1) -> constant;