diff options
| author | Badlop <badlop@process-one.net> | 2021-08-21 20:50:02 +0200 |
|---|---|---|
| committer | Badlop <badlop@process-one.net> | 2021-08-23 14:04:54 +0200 |
| commit | 655dcbcb7467db3cb0f89cf99d34cc2244e6c84f (patch) | |
| tree | 1ba339081042f8457b747da4dda6b084ef598d80 /src/ejabberd_commands.erl | |
| parent | Produce module names with specific syntax, docs Makefile will convert to links (diff) | |
New command to produce markdown with tags and their associated commands
Diffstat (limited to 'src/ejabberd_commands.erl')
| -rw-r--r-- | src/ejabberd_commands.erl | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/ejabberd_commands.erl b/src/ejabberd_commands.erl index 8d875e82..c00b1469 100644 --- a/src/ejabberd_commands.erl +++ b/src/ejabberd_commands.erl @@ -91,6 +91,16 @@ get_commands_spec() -> "that will have example invocation include in markdown document"], result_desc = "0 if command failed, 1 when succeeded", args_example = ["/home/me/docs/api.html", "mod_admin", "java,json"], + result_example = ok}, + #ejabberd_commands{name = gen_markdown_doc_for_tags, tags = [documentation], + desc = "Generates markdown documentation for ejabberd_commands", + module = ejabberd_commands_doc, function = generate_tags_md, + args = [{file, binary}], + result = {res, rescode}, + args_desc = ["Path to file where generated " + "documentation should be stored"], + result_desc = "0 if command failed, 1 when succeeded", + args_example = ["/home/me/docs/tags.md"], result_example = ok}]. start_link() -> |