Update documentation to match the implemented options values (#3675)

src/ejabberd_options_doc.erl

@@ -61,7 +61,7 @@ doc() ->
         desc =>
             ?T("The time of a cached item to keep in cache. "
 	       "Once it's expired, the corresponding item is "
-	       "erased from cache. The default value is 'one hour'. "
+	       "erased from cache. The default value is '1 hour'. "
 	       "Several modules have a similar option; and some core "
 	       "ejabberd parts support similar options too, see "
 	       "_`auth_cache_life_time`_, _`oauth_cache_life_time`_, "
@@ -382,14 +382,15 @@ doc() ->
                "from the stored information; for this reason, when this "
                "value is configured it cannot be changed to plain anymore. "
                "This format allows clients to authenticate using: "
-               "SASL PLAIN and SASL SCRAM-SHA-1.")]}},
+               "SASL PLAIN and SASL SCRAM-SHA-1."),
+            ?T("The default value is 'plain'.")]}},
      {auth_scram_hash,
       #{value => "sha | sha256 | sha512",
         desc =>
         ?T("Hash algorith that should be used to store password in SCRAM format. "
            "You shouldn't change this if you already have passwords generated with "
            "a different algorithm - users that have such passwords will not be able "
-           "to authenticate.")}},
+           "to authenticate. The default value is 'sha'.")}},
      {auth_use_cache,
       #{value => "true | false",
         desc =>
@@ -678,7 +679,8 @@ doc() ->
         desc =>
             ?T("The option defines the default language of server strings "
                "that can be seen by XMPP clients. If an XMPP client does not "
-               "possess 'xml:lang' attribute, the specified language is used.")}},
+               "possess 'xml:lang' attribute, the specified language is used. "
+               "The default value is '\"en\"'.")}},
      {ldap_servers,
       #{value => "[Host, ...]",
         desc =>
@@ -840,7 +842,7 @@ doc() ->
                "must have identical value on all nodes, or it will lead to subtle "
                "bugs. Usually leaving default value of this is option is best, "
                "tweak it only if you know what you are doing. "
-               "The default value is '1' minute.")}},
+               "The default value is '1 minute'.")}},
      {new_sql_schema,
       #{value => "true | false",
         desc =>
@@ -1154,7 +1156,7 @@ doc() ->
       #{value => "timeout()",
         desc =>
             ?T("A time to wait before closing an idle s2s connection. "
-               "The default value is '10' minutes.")}},
+               "The default value is '10 minutes'.")}},
      {s2s_use_starttls,
       #{value => "true | false | optional | required",
         desc =>

src/mod_admin_extra.erl

@@ -1652,14 +1652,6 @@ mod_doc() ->
            ?T("If you want to put a group Name with blankspaces, use the "
 	      "characters \"\' and \'\" to define when the Name starts and "
 	      "ends. See an example below.")],
-      opts =>
-          [{module_resource,
-            #{value => ?T("Resource"),
-              desc =>
-                  ?T("Indicate the resource that the XMPP stanzas must use "
-		     "in the FROM or TO JIDs. This is only useful in the "
-		     "'get_vcard*' and 'set_vcard*' commands. The default "
-		     "value is 'mod_admin_extra'.")}}],
       example =>
 	  [{?T("With this configuration, vCards can only be modified with "
 	       "mod_admin_extra commands:"),
@@ -1670,8 +1662,7 @@ mod_doc() ->
 	     "  vcard_set:",
 	     "    - allow: adminextraresource",
 	     "modules:",
-	     "  mod_admin_extra:",
+	     "  mod_admin_extra: {}",
-	     "    module_resource: \"modadminextraf8x,31ad\"",
 	     "  mod_vcard:",
 	     "    access_set: vcard_set"]},
 	   {?T("Content of roster file for 'pushroster' command:"),

src/mod_http_upload.erl

@@ -321,12 +321,13 @@ mod_doc() ->
                      "used for file uploads. The keyword @HOST@ is replaced "
                      "with the virtual host name. NOTE: different virtual "
                      "hosts cannot use the same PUT URL. "
-                     "The default value is \"https://@HOST@:5443\".")}},
+                     "The default value is \"https://@HOST@:5443/upload\".")}},
            {get_url,
             #{value => ?T("URL"),
               desc =>
                   ?T("This option specifies the initial part of the GET URLs "
-                     "used for downloading the files. By default, it is set "
+                     "used for downloading the files. The default value is 'undefined'. "
+                     "When this option is 'undefined', this option is set "
                      "to the same value as 'put_url'. The keyword @HOST@ is "
                      "replaced with the virtual host name. NOTE: if GET requests "
                      "are handled by 'mod_http_upload', the 'get_url' must match the "

src/mod_muc.erl

@@ -1366,19 +1366,19 @@ mod_doc() ->
               desc =>
                   ?T("To configure who is allowed to create new rooms at the "
                      "Multi-User Chat service, this option can be used. "
-                     "By default any account in the local ejabberd server is "
+                     "The default value is 'all', which means everyone is "
                      "allowed to create rooms.")}},
            {access_persistent,
             #{value => ?T("AccessName"),
               desc =>
                   ?T("To configure who is allowed to modify the 'persistent' room option. "
-                     "By default any account in the local ejabberd server is allowed to "
+                     "The default value is 'all', which means everyone is allowed to"
                      "modify that option.")}},
            {access_mam,
             #{value => ?T("AccessName"),
               desc =>
                   ?T("To configure who is allowed to modify the 'mam' room option. "
-                     "By default any account in the local ejabberd server is allowed to "
+                     "The default value is 'all', which means everyone is allowed to"
                      "modify that option.")}},
            {access_register,
             #{value => ?T("AccessName"),
@@ -1494,7 +1494,8 @@ mod_doc() ->
                   ?T("This option defines after how many users in the room, "
                      "it is considered overcrowded. When a MUC room is considered "
                      "overcrowed, presence broadcasts are limited to reduce load, "
-                     "traffic and excessive presence \"storm\" received by participants.")}},
+                     "traffic and excessive presence \"storm\" received by participants. "
+                     "The default value is '1000'.")}},
            {min_message_interval,
             #{value => ?T("Number"),
               desc =>

src/mod_ping.erl

@@ -300,7 +300,7 @@ mod_doc() ->
               desc =>
                   ?T("How long to wait before deeming that a client "
                      "has not answered a given server ping request. "
-                     "The default value is '32' seconds.")}},
+                     "The default value is 'undefined'.")}},
            {send_pings,
             #{value => "true | false",
               desc =>

src/mod_register.erl

@@ -679,7 +679,7 @@ mod_doc() ->
                      "https://en.wikipedia.org/wiki/Entropy_(information_theory)"
                      "[Shannon entropy] for passwords. The value 'Entropy' is a "
                      "number of bits of entropy. The recommended minimum is 32 bits. "
-                     "The default is 0, i.e. no checks are performed.")}},
+                     "The default is '0', i.e. no checks are performed.")}},
            {registration_watchers,
             #{value => "[JID, ...]",
               desc =>

src/mod_stream_mgmt.erl

@@ -970,4 +970,6 @@ mod_doc() ->
            {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. "
+                     "The default value is '48 hours'.")}}]}.

src/mod_stun_disco.erl

@@ -176,7 +176,7 @@ mod_doc() ->
 		     "clients. If ejabberd's built-in TURN service is used, "
 		     "TURN relays allocated using temporary credentials will "
 		     "be terminated shortly after the credentials expired. The "
-		     "default value is '12' hours. Note that restarting the "
+		     "default value is '12 hours'. Note that restarting the "
 		     "ejabberd node invalidates any temporary credentials "
 		     "offered before the restart unless a 'secret' is "
 		     "specified (see below).")}},