浏览代码

docs(schema): Add documentation for license application

ieQu1 4 年之前
父节点
当前提交
43aa2ea481
共有 1 个文件被更改,包括 9 次插入2 次删除
  1. 9 2
      lib-ee/emqx_license/src/emqx_license_schema.erl

+ 9 - 2
lib-ee/emqx_license/src/emqx_license_schema.erl

@@ -12,7 +12,7 @@
 
 -behaviour(hocon_schema).
 
--export([roots/0, fields/1, validations/0]).
+-export([roots/0, fields/1, validations/0, desc/1]).
 
 roots() ->
     [
@@ -40,7 +40,7 @@ fields(key_license) ->
             type => string(),
             %% so it's not logged
             sensitive => true,
-            desc => "Configure the license as a string"
+            desc => "License string"
         }}
         | common_fields()
     ];
@@ -53,6 +53,13 @@ fields(file_license) ->
         | common_fields()
     ].
 
+desc(key_license) ->
+    "License provisioned as a string.";
+desc(file_license) ->
+    "License provisioned as a file.";
+desc(_) ->
+    undefined.
+
 common_fields() ->
     [
         {connection_low_watermark, #{