aboutsummaryrefslogtreecommitdiffstats
path: root/lib/syntax_tools/src/erl_tidy.erl
diff options
context:
space:
mode:
authorHans Bolinder <[email protected]>2016-06-20 15:32:27 +0200
committerHans Bolinder <[email protected]>2016-07-07 08:39:50 +0200
commitfab6d311d90b2361b7e719ffa07a72b76826a55b (patch)
treeff35096eb4e9629cbc078660e7361c2c2e04e1ff /lib/syntax_tools/src/erl_tidy.erl
parent62074986287e10155293d19ac38659ed9521c018 (diff)
downloadotp-fab6d311d90b2361b7e719ffa07a72b76826a55b.tar.gz
otp-fab6d311d90b2361b7e719ffa07a72b76826a55b.tar.bz2
otp-fab6d311d90b2361b7e719ffa07a72b76826a55b.zip
syntax_tools: Improve types
Diffstat (limited to 'lib/syntax_tools/src/erl_tidy.erl')
-rw-r--r--lib/syntax_tools/src/erl_tidy.erl7
1 files changed, 5 insertions, 2 deletions
diff --git a/lib/syntax_tools/src/erl_tidy.erl b/lib/syntax_tools/src/erl_tidy.erl
index 3a37ca43bd..5d3fc6f062 100644
--- a/lib/syntax_tools/src/erl_tidy.erl
+++ b/lib/syntax_tools/src/erl_tidy.erl
@@ -36,6 +36,11 @@
%% been reasonably well tested, but the possibility of errors remains.
%% Keep backups of your original code safely stored, until you feel
%% confident that the new, modified code can be trusted.
+%%
+%% @type syntaxTree() = erl_syntax:syntaxTree(). An abstract syntax
+%% tree. See the {@link erl_syntax} module for details.
+%%
+%% @type filename() = file:filename().
-module(erl_tidy).
@@ -79,7 +84,6 @@ dir(Dir) ->
%% =====================================================================
%% @spec dir(Directory::filename(), Options::[term()]) -> ok
-%% filename() = file:filename()
%%
%% @doc Tidies Erlang source files in a directory and its
%% subdirectories.
@@ -513,7 +517,6 @@ module(Forms) ->
%% @spec module(Forms, Options::[term()]) -> syntaxTree()
%%
%% Forms = syntaxTree() | [syntaxTree()]
-%% syntaxTree() = erl_syntax:syntaxTree()
%%
%% @doc Tidies a syntax tree representation of a module
%% definition. The given `Forms' may be either a single