From 30a3ea3dc4de5487e967b04793a306e7af690b51 Mon Sep 17 00:00:00 2001
From: Thales Macedo Garitezi <thalesmg@gmail.com>
Date: Thu, 3 Nov 2022 10:43:27 -0300
Subject: [PATCH] docs: add docs for client enrichment / special auth module
 configurations

---
 priv/emqx.schema | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/priv/emqx.schema b/priv/emqx.schema
index 6ee8fb71c..c893d0521 100644
--- a/priv/emqx.schema
+++ b/priv/emqx.schema
@@ -852,10 +852,17 @@ end}.
   {datatype, string}
 ]}.
 
+%% @doc Specify a module that defines the `enrich_clientid_alias/2'
+%% function.  This function will be used to enrich the client/channel
+%% information with clientid and/or common name aliases (or other
+%% enrichments the module may implement).
 {mapping, "clientid_enrichment_module", "emqx.clientid_enrichment_module", [
   {datatype, atom}
 ]}.
 
+%% @doc Specify a module that defines the `check_authn/2' function.
+%% This function will be used in the `client.authenticate' hook as a
+%% way to implement custom authentication logic.
 {mapping, "special_auth_module", "emqx.special_auth_module", [
   {datatype, atom}
 ]}.