yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix function doc annotation

This commit is contained in:
Zaiming (Stone) Shi 2023-06-01 08:17:36 +02:00
parent be2d25515a
commit cb2be1811e
4 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/emqx/src/emqx_config.erl
View File

@ -617,7 +617,7 @@ save_to_override_conf(false, RawConf, _Opts) ->
backup_and_write(FileName, hocon_pp:do(RawConf, #{})) backup_and_write(FileName, hocon_pp:do(RawConf, #{}))
end. end.
%% @priv This is the same human-readable timestamp format as %% @private This is the same human-readable timestamp format as
%% hocon-cli generated app.<time>.config file name. %% hocon-cli generated app.<time>.config file name.
now_time() -> now_time() ->
Ts = os:system_time(millisecond), Ts = os:system_time(millisecond),

4
apps/emqx/src/emqx_release.erl
View File

@ -107,7 +107,7 @@ vsn_compare("v" ++ Vsn) ->
vsn_compare("e" ++ Vsn) -> vsn_compare("e" ++ Vsn) ->
vsn_compare(?EMQX_RELEASE_EE, Vsn). vsn_compare(?EMQX_RELEASE_EE, Vsn).
%% @priv Compare the second argument with the first argument, return %% @private Compare the second argument with the first argument, return
%% 'newer' 'older' or 'same' semver comparison result. %% 'newer' 'older' or 'same' semver comparison result.
vsn_compare(Vsn1, Vsn2) -> vsn_compare(Vsn1, Vsn2) ->
ParsedVsn1 = parse_vsn(Vsn1), ParsedVsn1 = parse_vsn(Vsn1),
@ -121,7 +121,7 @@ vsn_compare(Vsn1, Vsn2) ->
older older
end. end.
%% @priv Parse the version string to a tuple. %% @private Parse the version string to a tuple.
%% Return {{Major, Minor, Patch}, Suffix}. %% Return {{Major, Minor, Patch}, Suffix}.
%% Where Suffix is either an empty string or a tuple like {"rc", 1}. %% Where Suffix is either an empty string or a tuple like {"rc", 1}.
%% NOTE: taking the nature ordering of the suffix: %% NOTE: taking the nature ordering of the suffix:

2
apps/emqx_conf/src/emqx_cluster_rpc.erl
View File

@ -575,7 +575,7 @@ maybe_init_tnx_id(Node, TnxId) ->
{atomic, _} = transaction(fun ?MODULE:commit/2, [Node, TnxId]), {atomic, _} = transaction(fun ?MODULE:commit/2, [Node, TnxId]),
ok. ok.
%% @priv Cannot proceed until emqx app is ready. %% @private Cannot proceed until emqx app is ready.
%% Otherwise the committed transaction catch up may fail. %% Otherwise the committed transaction catch up may fail.
wait_for_emqx_ready() -> wait_for_emqx_ready() ->
%% wait 10 seconds for emqx to start %% wait 10 seconds for emqx to start

6
apps/emqx_conf/src/emqx_conf_app.erl
View File

@ -118,7 +118,7 @@ sync_cluster_conf() ->
sync_cluster_conf2(Nodes) sync_cluster_conf2(Nodes)
end. end.
%% @priv Some core nodes are running, try to sync the cluster config from them. %% @private Some core nodes are running, try to sync the cluster config from them.
sync_cluster_conf2(Nodes) -> sync_cluster_conf2(Nodes) ->
{Results, Failed} = emqx_conf_proto_v2:get_override_config_file(Nodes), {Results, Failed} = emqx_conf_proto_v2:get_override_config_file(Nodes),
{Ready, NotReady0} = lists:partition(fun(Res) -> element(1, Res) =:= ok end, Results), {Ready, NotReady0} = lists:partition(fun(Res) -> element(1, Res) =:= ok end, Results),
@ -177,7 +177,7 @@ sync_cluster_conf2(Nodes) ->
sync_cluster_conf3(Ready) sync_cluster_conf3(Ready)
end. end.
%% @priv Filter out the nodes which are running a newer version than this node. %% @private Filter out the nodes which are running a newer version than this node.
sync_cluster_conf3(Ready) -> sync_cluster_conf3(Ready) ->
NotNewer = fun({ok, #{release := RemoteRelease}}) -> NotNewer = fun({ok, #{release := RemoteRelease}}) ->
try try
@ -210,7 +210,7 @@ sync_cluster_conf3(Ready) ->
sync_cluster_conf4(Ready2) sync_cluster_conf4(Ready2)
end. end.
%% @priv Some core nodes are running and replied with their configs successfully. %% @private Some core nodes are running and replied with their configs successfully.
%% Try to sort the results and save the first one for local use. %% Try to sort the results and save the first one for local use.
sync_cluster_conf4(Ready) -> sync_cluster_conf4(Ready) ->
[{ok, Info} | _] = lists:sort(fun conf_sort/2, Ready), [{ok, Info} | _] = lists:sort(fun conf_sort/2, Ready),