diff options
| author | Badlop <badlop@process-one.net> | 2021-08-21 18:31:21 +0200 |
|---|---|---|
| committer | Badlop <badlop@process-one.net> | 2021-08-23 14:04:49 +0200 |
| commit | 506e2f3b972a7e1b6d4fdd40836b9574c4937908 (patch) | |
| tree | 2577288f11b50436c0b7ac9be5a5c5f926db69ef /src/mod_shared_roster.erl | |
| parent | Improve formatting and add sections links (diff) | |
Use specific syntax so modules and top-level will be links
If we use _`whatever`_ here in ejabberd man pages,
it is converted to *`whatever`* in markdown,
and docs.ejabberd.im/Makefile converts to the proper links
Diffstat (limited to 'src/mod_shared_roster.erl')
| -rw-r--r-- | src/mod_shared_roster.erl | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/mod_shared_roster.erl b/src/mod_shared_roster.erl index 16cc96a75..13ff90466 100644 --- a/src/mod_shared_roster.erl +++ b/src/mod_shared_roster.erl @@ -1266,7 +1266,7 @@ mod_doc() -> ?T("- Displayed: A list of groups that will be in the " "rosters of this group's members. A group of other vhost can " "be identified with 'groupid@vhost'."), "", - ?T("This module depends on 'mod_roster'. " + ?T("This module depends on _`mod_roster`_. " "If not enabled, roster queries will return 503 errors.")], opts => [{db_type, @@ -1274,25 +1274,25 @@ mod_doc() -> desc => ?T("Define the type of storage where the module will create " "the tables and store user information. The default is " - "the storage defined by the global option 'default_db', " + "the storage defined by the top-level _`default_db`_ option, " "or 'mnesia' if omitted. If 'sql' value is defined, " "make sure you have defined the database.")}}, - {use_cache, + {use_cache, #{value => "true | false", desc => - ?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, + ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}}, {cache_size, #{value => "pos_integer() | infinity", desc => - ?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, + ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}}, {cache_missed, #{value => "true | false", desc => - ?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, + ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}}, {cache_life_time, #{value => "timeout()", desc => - ?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}], + ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}], example => [{?T("Take the case of a computer club that wants all its members " "seeing each other in their rosters. To achieve this, they " |