From 3e2023e761c4779c5ee32204ae9820a52a3c1f84 Mon Sep 17 00:00:00 2001 From: dengzhongwen Date: Tue, 4 Sep 2018 18:37:54 +0800 Subject: [PATCH] update doc for external link. --- src/eenv.app.src | 2 +- src/eenv.erl | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/eenv.app.src b/src/eenv.app.src index b742a17..407e518 100644 --- a/src/eenv.app.src +++ b/src/eenv.app.src @@ -1,6 +1,6 @@ {application, eenv, [{description, "Application Configuration Manager"}, - {vsn, "0.1.0"}, + {vsn, "0.1.1"}, {registered, []}, {applications, [kernel, stdlib]}, diff --git a/src/eenv.erl b/src/eenv.erl index c4ed3f1..1c837c9 100644 --- a/src/eenv.erl +++ b/src/eenv.erl @@ -58,9 +58,9 @@ unload(Apps) when is_list(Apps) -> get(Application, Par) -> ?ROUTER_MOD:get(Application, Par). -%% @doc Works like get/2 but +%% @doc Works like {@link get/2} but %% Returns value Default when configuration parameter Par does not exist. -%% Returns `application:get_env(Application, Par, Default)` when application is not loaded by eenv. +%% Returns application:get_env(App, Par, Default) when application is not loaded by eenv. -spec get(Application, Par, Default) -> Val when Application :: atom(), Par :: atom(), @@ -73,7 +73,7 @@ get(Application, Par, Default) -> ?UNLOADED -> application:get_env(Application, Par, Default) end. -%% @doc Sets the value of configuration parameter Par for Application. Same as 'application:set_env/3`. +%% @doc Sets the value of configuration parameter Par for Application. Same as application:get_env/3. %% Use this function only if you know what you are doing, that is, on your own applications. %% It is very application-dependent and configuration parameter-dependent when and how often the value is read by the application. %% Careless use of this function can put the application in a weird, inconsistent, and malfunctioning state. @@ -86,7 +86,7 @@ set(Application, Par, Val) -> load_app_module(Application), ok. -%% @doc Sets the value of configuration parameter Par for Application. Same as 'application:set_env/4`. +%% @doc Sets the value of configuration parameter Par for Application. Same as application:set_env/4. -spec set(Application, Par, Val, Opt) -> 'ok' when Application :: atom(), Par :: atom(), @@ -97,7 +97,7 @@ set(Application, Par, Val, Opt) -> load_app_module(Application), ok. -%% @doc Works like set/3. with setting in batches. +%% @doc Works like {@link set/3}. with setting in batches. -spec set(Application, List) -> 'ok' when Application :: atom(), List :: [{atom(), term()}]. @@ -107,7 +107,7 @@ set(Application, List) -> ok. %% @doc Removes the configuration parameter Par and its value for Application. -%% Same as 'application:unset_env(Application, Par)`. +%% Same as application:unset_env(Application, Par). -spec unset(Application, Pars) -> 'ok' when Application :: atom(), Pars :: atom() | [atom()]. @@ -121,7 +121,7 @@ unset(Application, Pars) when is_list(Pars) -> ok. %% @doc Removes the configuration parameter Par and its value for Application. -%% Same as 'application:unset_env(Application, Par, Opt)`. +%% Same as application:unset_env(Application, Par, Opt). -spec unset(Application, Pars, Opt) -> 'ok' when Application :: atom(), Opt :: [{timeout, timeout()} | {persistent, boolean()}],