aboutsummaryrefslogtreecommitdiffstats
path: root/lib/syntax_tools/src/erl_tidy.erl
diff options
context:
space:
mode:
authorAaron <[email protected]>2013-06-02 21:46:25 +0200
committerHenrik Nord <[email protected]>2014-01-23 10:58:47 +0100
commita857d28603ad674c40a977249c1b6ae8d29c1f6c (patch)
tree72ad5eb06e5ea18f81f592cfb34bb6af508474d9 /lib/syntax_tools/src/erl_tidy.erl
parenteb7c881a62e306f598a930b4781ecbbb67e37424 (diff)
downloadotp-a857d28603ad674c40a977249c1b6ae8d29c1f6c.tar.gz
otp-a857d28603ad674c40a977249c1b6ae8d29c1f6c.tar.bz2
otp-a857d28603ad674c40a977249c1b6ae8d29c1f6c.zip
Added documenation for the new option describing what it does.
Diffstat (limited to 'lib/syntax_tools/src/erl_tidy.erl')
-rw-r--r--lib/syntax_tools/src/erl_tidy.erl7
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/syntax_tools/src/erl_tidy.erl b/lib/syntax_tools/src/erl_tidy.erl
index 8507ff646e..7444d8dc67 100644
--- a/lib/syntax_tools/src/erl_tidy.erl
+++ b/lib/syntax_tools/src/erl_tidy.erl
@@ -269,6 +269,13 @@ file(Name) ->
%% is typically most useful if the `verbose' flag is enabled, to
%% generate reports about the program files without affecting
%% them. The default value is `false'.</dd>
+%%
+%% <dt>{stdout, boolean()}</dt>
+%%
+%% <dd>If the value is `true', instead of the file being written
+%% to disk it will be printed to stdout. The default value is
+%% `false'.</dd>
+%%
%% </dl>
%%
%% See the function `module/2' for further options.