From cb2be1811e3f99280e4d827520e6fb628a72573a Mon Sep 17 00:00:00 2001
From: "Zaiming (Stone) Shi" <zmstone@gmail.com>
Date: Thu, 1 Jun 2023 08:17:36 +0200
Subject: [PATCH] docs: fix function doc annotation

---
 apps/emqx/src/emqx_config.erl           | 2 +-
 apps/emqx/src/emqx_release.erl          | 4 ++--
 apps/emqx_conf/src/emqx_cluster_rpc.erl | 2 +-
 apps/emqx_conf/src/emqx_conf_app.erl    | 6 +++---
 4 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/apps/emqx/src/emqx_config.erl b/apps/emqx/src/emqx_config.erl
index c84a1fb9c..3891f4bdf 100644
--- a/apps/emqx/src/emqx_config.erl
+++ b/apps/emqx/src/emqx_config.erl
@@ -617,7 +617,7 @@ save_to_override_conf(false, RawConf, _Opts) ->
             backup_and_write(FileName, hocon_pp:do(RawConf, #{}))
     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.
 now_time() ->
     Ts = os:system_time(millisecond),
diff --git a/apps/emqx/src/emqx_release.erl b/apps/emqx/src/emqx_release.erl
index 9a930649e..c052eecc9 100644
--- a/apps/emqx/src/emqx_release.erl
+++ b/apps/emqx/src/emqx_release.erl
@@ -107,7 +107,7 @@ vsn_compare("v" ++ Vsn) ->
 vsn_compare("e" ++ 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.
 vsn_compare(Vsn1, Vsn2) ->
     ParsedVsn1 = parse_vsn(Vsn1),
@@ -121,7 +121,7 @@ vsn_compare(Vsn1, Vsn2) ->
             older
     end.
 
-%% @priv Parse the version string to a tuple.
+%% @private Parse the version string to a tuple.
 %% Return {{Major, Minor, Patch}, Suffix}.
 %% Where Suffix is either an empty string or a tuple like {"rc", 1}.
 %% NOTE: taking the nature ordering of the suffix:
diff --git a/apps/emqx_conf/src/emqx_cluster_rpc.erl b/apps/emqx_conf/src/emqx_cluster_rpc.erl
index c82191bc3..91558630f 100644
--- a/apps/emqx_conf/src/emqx_cluster_rpc.erl
+++ b/apps/emqx_conf/src/emqx_cluster_rpc.erl
@@ -575,7 +575,7 @@ maybe_init_tnx_id(Node, TnxId) ->
     {atomic, _} = transaction(fun ?MODULE:commit/2, [Node, TnxId]),
     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.
 wait_for_emqx_ready() ->
     %% wait 10 seconds for emqx to start
diff --git a/apps/emqx_conf/src/emqx_conf_app.erl b/apps/emqx_conf/src/emqx_conf_app.erl
index 363e367b6..c1a3b5df5 100644
--- a/apps/emqx_conf/src/emqx_conf_app.erl
+++ b/apps/emqx_conf/src/emqx_conf_app.erl
@@ -118,7 +118,7 @@ sync_cluster_conf() ->
             sync_cluster_conf2(Nodes)
     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) ->
     {Results, Failed} = emqx_conf_proto_v2:get_override_config_file(Nodes),
     {Ready, NotReady0} = lists:partition(fun(Res) -> element(1, Res) =:= ok end, Results),
@@ -177,7 +177,7 @@ sync_cluster_conf2(Nodes) ->
             sync_cluster_conf3(Ready)
     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) ->
     NotNewer = fun({ok, #{release := RemoteRelease}}) ->
         try
@@ -210,7 +210,7 @@ sync_cluster_conf3(Ready) ->
             sync_cluster_conf4(Ready2)
     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.
 sync_cluster_conf4(Ready) ->
     [{ok, Info} | _] = lists:sort(fun conf_sort/2, Ready),