Merge branch 'hb/edoc/specs_and_types/OTP-8525' into dev

* hb/edoc/specs_and_types/OTP-8525:
  Make Erlang specifications and types available in EDoc

1 files changed, 21 insertions, 13 deletions

diff --git a/lib/edoc/src/edoc.erl b/lib/edoc/src/edoc.erl
index 75b3bb451a..360f2dbc9e 100644
--- a/lib/edoc/src/edoc.erl
+++ b/lib/edoc/src/edoc.erl
@@ -258,6 +258,7 @@ opt_defaults() ->
 opt_negations() ->
     [{no_preprocess, preprocess},
      {no_subpackages, subpackages},
+     {no_report_missing_types, report_missing_types},
      {no_packages, packages}].
 
 %% @spec run(Packages::[package()],
@@ -310,13 +311,13 @@ opt_negations() ->
 %%  <dd>Specifies the suffix used for output files. The default value is
 %%      `".html"'. Note that this also affects generated references.
 %%  </dd>
-%%  <dt>{@type {new, bool()@}}
+%%  <dt>{@type {new, boolean()@}}
 %%  </dt>
 %%  <dd>If the value is `true', any existing `edoc-info' file in the
 %%      target directory will be ignored and overwritten. The default
 %%      value is `false'.
 %%  </dd>
-%%  <dt>{@type {packages, bool()@}}
+%%  <dt>{@type {packages, boolean()@}}
 %%  </dt>
 %%  <dd>If the value is `true', it it assumed that packages (module
 %%      namespaces) are being used, and that the source code directory
@@ -342,7 +343,7 @@ opt_negations() ->
 %%  <dd>Specifies the expected suffix of input files. The default
 %%      value is `".erl"'.
 %%  </dd>
-%%  <dt>{@type {subpackages, bool()@}}
+%%  <dt>{@type {subpackages, boolean()@}}
 %%  </dt>
 %%  <dd>If the value is `true', all subpackages of specified packages
 %%      will also be included in the documentation. The default value is
@@ -578,6 +579,12 @@ layout(Doc, Opts) ->
 
 
 %% @spec (File) ->  [comment()]
+%% @type comment() = {Line, Column, Indentation, Text}
+%% where
+%%   Line = integer(),
+%%   Column = integer(),
+%%   Indentation = integer(),
+%%   Text = [string()]
 %% @equiv read_comments(File, [])
 
 read_comments(File) ->
@@ -585,12 +592,6 @@ read_comments(File) ->
 
 %% @spec read_comments(File::filename(), Options::proplist()) ->
 %%           [comment()]
-%% where
-%%   comment() = {Line, Column, Indentation, Text},
-%%   Line = integer(),
-%%   Column = integer(),
-%%   Indentation = integer(),
-%%   Text = [string()]
 %%
 %% @doc Extracts comments from an Erlang source code file. See the
 %% module {@link //syntax_tools/erl_comment_scan} for details on the
@@ -616,7 +617,7 @@ read_source(Name) ->
 %%
 %% Options:
 %% <dl>
-%%  <dt>{@type {preprocess, bool()@}}
+%%  <dt>{@type {preprocess, boolean()@}}
 %%  </dt>
 %%  <dd>If the value is `true', the source file will be read via the
 %%      Erlang preprocessor (`epp'). The default value is `false'.
@@ -642,6 +643,13 @@ read_source(Name) ->
 %%      macro definitions, used if the `preprocess' option is turned on.
 %%      The default value is the empty list.</dd>
 %% </dl>
+%%  <dt>{@type {report_missing_types, boolean()@}}
+%%  </dt>
+%%  <dd>If the value is `true', warnings are issued for missing types.
+%%      The default value is `false'.
+%%      `no_report_missing_types' is an alias for
+%%      `{report_missing_types, false}'.
+%%  </dd>
 %%
 %% @see get_doc/2
 %% @see //syntax_tools/erl_syntax
@@ -724,17 +732,17 @@ get_doc(File) ->
 %%    <a href="overview-summary.html#Macro_expansion">Inline macro expansion</a>
 %%    for details.
 %%  </dd>
-%%  <dt>{@type {hidden, bool()@}}
+%%  <dt>{@type {hidden, boolean()@}}
 %%  </dt>
 %%  <dd>If the value is `true', documentation of hidden functions will
 %%      also be included. The default value is `false'.
 %%  </dd>
-%%  <dt>{@type {private, bool()@}}
+%%  <dt>{@type {private, boolean()@}}
 %%  </dt>
 %%  <dd>If the value is `true', documentation of private functions will
 %%      also be included. The default value is `false'.
 %%  </dd>
-%%  <dt>{@type {todo, bool()@}}
+%%  <dt>{@type {todo, boolean()@}}
 %%  </dt>
 %%  <dd>If the value is `true', To-Do notes written using `@todo' or
 %%  `@TODO' tags will be included in the documentation. The default