mirror of
https://github.com/processone/ejabberd.git
synced 2024-11-24 16:23:40 +01:00
Use same module shorthand in API documentation than in module docs
This commit is contained in:
parent
15e3add909
commit
569f0b303b
@ -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,
|
||||
|
@ -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,
|
||||
|
Loading…
Reference in New Issue
Block a user