diff options
| author | Radek Szymczyszyn <radoslaw.szymczyszyn@erlang-solutions.com> | 2020-12-07 16:06:06 +0100 |
|---|---|---|
| committer | Radek Szymczyszyn <radoslaw.szymczyszyn@erlang-solutions.com> | 2020-12-21 10:33:15 +0100 |
| commit | 63d0d7125db3aaa0a6260310f4c24cd0fb457457 (patch) | |
| tree | 9c73456784840aac08f9581777f3a0b9e851a6f9 | |
| parent | 07d71c6532b916600c0598758f8684c18418307d (diff) | |
| download | erlang-63d0d7125db3aaa0a6260310f4c24cd0fb457457.tar.gz | |
Remove @doc tags in edoc_parser.yrl
These tags cause EDoc to crash when it generates docs for itself with `{preprocess, true}`:
1> edoc:application(edoc, []).
/Users/erszcz/work/erlang/otp/lib/edoc/include/../include/edoc_doclet.hrl: warning: documentation before module declaration is ignored by @headerfile
/Users/erszcz/work/erlang/otp/lib/edoc/src/edoc_types.hrl: warning: documentation before module declaration is ignored by @headerfile
ok
2>
2>
2> edoc:application(edoc, [{preprocess, true}]).
/Users/erszcz/work/erlang/otp/lib/edoc/include/../include/edoc_doclet.hrl: warning: documentation before module declaration is ignored by @headerfile
/Users/erszcz/work/erlang/otp/lib/edoc/src/edoc_types.hrl: warning: documentation before module declaration is ignored by @headerfile
/Users/erszcz/work/erlang/otp/lib/edoc/src/edoc_parser.erl, in module footer: at line 138: tag @doc not allowed here.
/Users/erszcz/work/erlang/otp/lib/edoc/src/edoc_parser.erl, in module footer: at line 157: multiple @doc tag.
/Users/erszcz/work/erlang/otp/lib/edoc/src/edoc_parser.erl, in module footer: at line 168: multiple @doc tag.
/Users/erszcz/work/erlang/otp/lib/edoc/src/edoc_parser.erl, in module footer: at line 181: multiple @doc tag.
edoc: skipping source file '/Users/erszcz/work/erlang/otp/lib/edoc/src/edoc_parser.erl': {'EXIT', error}.
edoc: error in doclet 'edoc_doclet': {'EXIT',error}.
** exception exit: error
in function edoc_lib:run_plugin/5 (edoc_lib.erl, line 868)
3>
| -rw-r--r-- | lib/edoc/src/edoc_parser.yrl | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/edoc/src/edoc_parser.yrl b/lib/edoc/src/edoc_parser.yrl index a336edd7e5..10a2fd2a9a 100644 --- a/lib/edoc/src/edoc_parser.yrl +++ b/lib/edoc/src/edoc_parser.yrl @@ -380,7 +380,7 @@ parse_typedef_1(S, L) -> %% --------------------------------------------------------------------- -%% @doc Parses a <a +%% Parses a <a %% href="overview-summary.html#References">reference</a> to a module, %% function, type, or application @@ -399,7 +399,7 @@ parse_ref(S, L) -> %% --------------------------------------------------------------------- -%% @doc Parses the content of +%% Parses the content of %% <a href="overview-summary.html#ftag-see">`@see'</a> references. parse_see(S, L) -> {S1, S2} = edoc_lib:split_at_stop(S), @@ -410,7 +410,7 @@ parse_see(S, L) -> %% --------------------------------------------------------------------- -%% @doc Parses the content of +%% Parses the content of %% <a href="overview-summary.html#ftag-param">`@param'</a> tags. parse_param(S, L) -> {S1, S2} = edoc_lib:split_at_space(edoc_lib:strip_space(S)), @@ -423,7 +423,7 @@ parse_param(S, L) -> %% --------------------------------------------------------------------- -%% @doc EDoc exception specification parsing. Parses the content of +%% EDoc exception specification parsing. Parses the content of %% <a href="overview-summary.html#ftag-throws">`@throws'</a> declarations. parse_throws(S, L) -> |