ソースを参照

docs(schema): Formatting

ieQu1 3 年 前
コミット
6f4e7dc118

+ 3 - 1
apps/emqx_conf/src/emqx_conf_schema.erl

@@ -626,7 +626,9 @@ fields("log") ->
     , {"error_logger",
        sc(atom(),
           #{mapping => "kernel.error_logger",
-            default => silent})}
+            default => silent,
+            desc => "Deprecated."
+           })}
     ];
 
 fields("console_handler") ->

+ 10 - 9
apps/emqx_modules/src/emqx_modules_schema.erl

@@ -123,15 +123,16 @@ fields("event_message") ->
                     }
                 )}
         ],
-    #{fields => Fields,
-      desc => """
-Enable/Disable system event messages.
-The messages are published to <code>$event</code> prefixed topics.
-For example, if `client_disconnected` is set to `true`,
-a message is published to <code>$event/client_connected</code> topic
-whenever a client is connected.
-"""};
-
+    #{
+        fields => Fields,
+        desc =>
+            "Enable/Disable system event messages.\n"
+            "The messages are published to <code>$event</code> prefixed topics.\n"
+            "For example, if `client_disconnected` is set to `true`,\n"
+            "a message is published to <code>$event/client_connected</code> topic\n"
+            "whenever a client is connected.\n"
+            ""
+    };
 fields("topic_metrics") ->
     [{topic, sc(binary(), #{})}].