From 569f0b303bc6db7541894c57d8e7d4278d53bc30 Mon Sep 17 00:00:00 2001 From: Badlop Date: Thu, 14 Mar 2024 13:24:07 +0100 Subject: [PATCH] Use same module shorthand in API documentation than in module docs --- src/ejabberd_commands_doc.erl | 6 +++--- src/mod_muc_admin.erl | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/ejabberd_commands_doc.erl b/src/ejabberd_commands_doc.erl index 485e7f68e..a8093efcb 100644 --- a/src/ejabberd_commands_doc.erl +++ b/src/ejabberd_commands_doc.erl @@ -364,7 +364,7 @@ make_tags(HTMLOutput) -> -dialyzer({no_match, gen_tags/2}). gen_tags({TagName, Commands}, HTMLOutput) -> - [?TAG(h1, TagName) | [?TAG(p, ?RAW("* *`"++C++"`*")) || C <- Commands]]. + [?TAG(h1, TagName) | [?TAG(p, ?RAW("* _`"++C++"`_")) || C <- Commands]]. gen_doc(#ejabberd_commands{name=Name, tags=Tags, desc=Desc, longdesc=LongDesc, args=Args, args_desc=ArgsDesc, note=Note, definer=Definer, @@ -395,14 +395,14 @@ gen_doc(#ejabberd_commands{name=Name, tags=Tags, desc=Desc, longdesc=LongDesc, [?TAG(dl, [gen_param(RName, Type, ResultDesc, HTMLOutput)])] end end, - TagsText = ?RAW(string:join(["*`"++atom_to_list(Tag)++"`*" || Tag <- Tags], ", ")), + TagsText = ?RAW(string:join(["_`"++atom_to_list(Tag)++"`_" || Tag <- Tags], ", ")), IsDefinerMod = case Definer of unknown -> false; _ -> lists:member(gen_mod, proplists:get_value(behaviour, Definer:module_info(attributes))) end, ModuleText = case IsDefinerMod of true -> - [?TAG(h2, <<"Module:">>), ?TAG(p, ?RAW("*`"++atom_to_list(Definer)++"`*"))]; + [?TAG(h2, <<"Module:">>), ?TAG(p, ?RAW("_`"++atom_to_list(Definer)++"`_"))]; false -> [] end, diff --git a/src/mod_muc_admin.erl b/src/mod_muc_admin.erl index a0f62f145..59ccb3804 100644 --- a/src/mod_muc_admin.erl +++ b/src/mod_muc_admin.erl @@ -380,7 +380,7 @@ get_commands_spec() -> desc = "Subscribe several users to a MUC conference", note = "added in 22.05", longdesc = "This command accepts up to 50 users at once " - "(this is configurable with the *`mod_muc_admin`* option " + "(this is configurable with the _`mod_muc_admin`_ option " "`subscribe_room_many_max_users`)", module = ?MODULE, function = subscribe_room_many, args_desc = ["Users JIDs and nicks", @@ -402,7 +402,7 @@ get_commands_spec() -> #ejabberd_commands{name = subscribe_room_many, tags = [muc_room, muc_sub], desc = "Subscribe several users to a MUC conference", longdesc = "This command accepts up to 50 users at once " - "(this is configurable with the *`mod_muc_admin`* option " + "(this is configurable with the _`mod_muc_admin`_ option " "`subscribe_room_many_max_users`)", module = ?MODULE, function = subscribe_room_many, version = 1,