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

fix(typedoc): meld it into the field doc in the meantime

This commit is contained in:
Andrew Mayorov 2023-12-21 17:13:37 +01:00
parent 1290f1794a
commit aa3f8d6735
No known key found for this signature in database
GPG Key ID: 2837C62ACFBFED5D
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
apps/emqx_conf/src/emqx_conf.erl
View File

@ -323,10 +323,12 @@ format_fields(Fields, DescResolver) ->
[format_field(F, DescResolver) || F <- Fields].
format_field(#{name := Name, aliases := Aliases, type := Type} = F, DescResolver) ->
TypeDoc = format_type_desc(Type, DescResolver),
L = [
{text, Name},
{type, format_type(Type)},
{typedoc, format_type_desc(Type, DescResolver)},
%% TODO: Make it into a separate field.
%% {typedoc, format_type_desc(Type, DescResolver)},
{refs, format_refs(Type)},
{aliases,
case Aliases of
@ -334,7 +336,7 @@ format_field(#{name := Name, aliases := Aliases, type := Type} = F, DescResolver
_ -> Aliases
end},
{default, maps:get(hocon, maps:get(default, F, #{}), undefined)},
{doc, maps:get(desc, F, undefined)}
{doc, join_format([maps:get(desc, F, undefined), TypeDoc])}
],
maps:from_list([{K, V} || {K, V} <- L, V =/= undefined]).
@ -577,6 +579,14 @@ hocon_schema_to_spec(Atom, _LocalModule) when is_atom(Atom) ->
typename_to_spec(TypeStr, Module) ->
emqx_conf_schema_types:readable_dashboard(Module, TypeStr).
join_format(Snippets) ->
case [S || S <- Snippets, S =/= undefined] of
[] ->
undefined;
NonEmpty ->
to_bin(lists:join("<br/>", NonEmpty))
end.
to_bin(List) when is_list(List) -> iolist_to_binary(List);
to_bin(Boolean) when is_boolean(Boolean) -> Boolean;
to_bin(Atom) when is_atom(Atom) -> atom_to_binary(Atom, utf8);