diff options
| author | Badlop <badlop@process-one.net> | 2021-05-05 11:41:06 +0200 |
|---|---|---|
| committer | Badlop <badlop@process-one.net> | 2021-05-05 11:57:02 +0200 |
| commit | 999d0af502f37232ba9c9b3ed09855a89c9cc097 (patch) | |
| tree | 01a7f4e80b2cf8c23340818b5497c436bc1b101f /src/ejabberd_doc.erl | |
| parent | Fix invalid_encoding error when using extended plane characters in vcard. (diff) | |
New 'note' field in commands and options documentation
Diffstat (limited to 'src/ejabberd_doc.erl')
| -rw-r--r-- | src/ejabberd_doc.erl | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/ejabberd_doc.erl b/src/ejabberd_doc.erl index 89f1be11..77f9fab4 100644 --- a/src/ejabberd_doc.erl +++ b/src/ejabberd_doc.erl @@ -159,6 +159,10 @@ opt_to_man(Lang, {Option, Options, Children}, Level) -> lists:keysort(1, Children))]) ++ [io_lib:nl()|format_example(Level, Lang, Options)]. +format_option(Lang, Option, #{note := Note, value := Val}) -> + "\n\n_Note_ about the next option: " ++ Note ++ ":\n\n"++ + "*" ++ atom_to_list(Option) ++ "*: 'pass:[" ++ + tr(Lang, Val) ++ "]'::"; format_option(Lang, Option, #{value := Val}) -> "*" ++ atom_to_list(Option) ++ "*: 'pass:[" ++ tr(Lang, Val) ++ "]'::"; |