From 54b9240e2133644d424546a701c8a5c271981168 Mon Sep 17 00:00:00 2001 From: Tristan Sloughter Date: Sun, 30 Aug 2020 13:45:13 -0600 Subject: [PATCH] fix edoc xml and configuration --- rebar.config | 3 ++- src/rlx_app_info.erl | 4 ++-- src/rlx_release.erl | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/rebar.config b/rebar.config index 8a4d4b23f..8b19cf1ae 100644 --- 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 index b81b97932..6f2774c6c 100644 --- 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 %%%
  • `included_applications' - The apps in the `included_applications' property -%%% of the application metadata. -%%% +%%% of the application metadata.
  • +%%% %%% -module(rlx_app_info). diff --git a/src/rlx_release.erl b/src/rlx_release.erl index 6c1703d9b..30206eb2f 100644 --- 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 (-) for this release +%% @doc produce the canonical name `-' 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])).