Replace @spec/@type tags with corresponding attributes

This also moves types from header files to modules,
so that they're namespaced.

@spec/@type syntax allows to specify an application that is
referrred to (e.g. `//syntax_tools/erl_syntax:forms()`),
whereas the -spec/-type attribute syntax doesn't.
In order to keep links generated by EDoc valid,
an app name inference mechanism is introduced,
which works based on the modules currently available in the code path.
This allows to use specs/types which refer to types defined outside the
current application and make sure EDoc will generate proper external links.

1 files changed, 5 insertions, 28 deletions

diff --git a/lib/edoc/include/edoc_doclet.hrl b/lib/edoc/include/edoc_doclet.hrl
index a05a9cb2bc..c15ba13aad 100644
--- a/lib/edoc/include/edoc_doclet.hrl
+++ b/lib/edoc/include/edoc_doclet.hrl
@@ -28,36 +28,13 @@
 
 -define(NO_APP, []).
 
-%% Context for doclets
-
-%% @type edoc_context() = #context{dir = string(),
-%%                                 env = edoc_lib:edoc_env(),
-%%                                 opts = [term()]}
-
--record(context, {dir = "",
-		  env,
-		  opts = []}).
-
-%% Doclet commands
-
-%% @type no_app().
-%%    A value used to mark absence of an Erlang application
-%%    context. Use the macro `NO_APP' defined in
-%%    <a href="edoc_doclet.hrl">`edoc_doclet.hrl'</a>
-%%    to produce this value.
-
-%% @type doclet_gen() = #doclet_gen{sources = [string()],
-%%                                  app = no_app() | atom(),
-%%                                  modules = [atom()]}
+-record(doclet_context, {dir = "",
+			 env,
+			 opts = []}).
 
 -record(doclet_gen, {sources = [],
 		     app = ?NO_APP,
-		     modules = []
-		    }).
-
-%% @type doclet_toc() = #doclet_gen{paths = [string()],
-%%                                  indir = string()}
+		     modules = []}).
 
 -record(doclet_toc, {paths,
-		     indir
-		    }).
+		     indir}).