Merge pull request #820 from tsloughter/edoc-fixes

fix edoc xml and configuration
erlware · Aug 30, 2020 · 7b2f7ea · 7b2f7ea
2 parents f2aefc5 + 54b9240
commit 7b2f7ea
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/rebar.config b/rebar.config
@@ -7,7 +7,8 @@
 
 %% Profiles ====================================================================
 
-{profiles, [{test, [{erl_opts, [nowarn_export_all]}]}]}.
+{profiles, [{test, [{erl_opts, [nowarn_export_all]}]},
+            {docs, [{edoc_opts, [{preprocess, true}]}]}]}.
 
 {overrides, [{override, bbmustache, [{deps, []}, {plugins, []}]}]}.
 

diff --git a/src/rlx_app_info.erl b/src/rlx_app_info.erl
@@ -31,8 +31,8 @@
 %%%  App. That is the things in the `applications' property of the application
 %%%  metadata </li>
 %%%  <li> `included_applications' - The apps in the `included_applications' property
-%%%  of the application metadata.
-%%%  </ul>
+%%%  of the application metadata.</li>
+%%% </ul>
 %%%
 -module(rlx_app_info).
 

diff --git a/src/rlx_release.erl b/src/rlx_release.erl
@@ -190,7 +190,7 @@ no_dot_erlang_metadata(#release_t{erts=ErtsVsn,
     {value, StdLib, _Apps2} = lists:keytake(stdlib, 1, Apps1),
     {release, {"no_dot_erlang", "1.0"}, {erts, ErtsVsn}, [Kernel, StdLib]}.
 
-%% @doc produce the canonical name (<name>-<vsn>) for this release
+%% @doc produce the canonical name `<name>-<vsn>' for this release
 -spec canonical_name(t()) -> string().
 canonical_name(#release_t{name=Name, vsn=Vsn}) ->
     erlang:binary_to_list(erlang:iolist_to_binary([erlang:atom_to_list(Name), "-", Vsn])).