]> git.ipfire.org Git - thirdparty/asterisk.git/commitdiff
docs: Various XML fixes
authorGeorge Joseph <gjoseph@sangoma.com>
Wed, 15 Jan 2025 23:19:27 +0000 (16:19 -0700)
committerGeorge Joseph <gjoseph@sangoma.com>
Thu, 16 Jan 2025 15:32:50 +0000 (15:32 +0000)
* channels/pjsip/dialplan_functions_doc.xml: Added xmlns:xi to docs element.

* main/bucket.c: Removed XML completely since the "bucket" and "file" objects
  are internal only with no config file.

* main/named_acl.c: Fixed the configFile element name. It was "named_acl.conf"
  and should have been "acl.conf"

* res/res_geolocation/geoloc_doc.xml: Added xmlns:xi to docs element.

* res/res_http_media_cache.c: Fixed the configFile element name. It was
  "http_media_cache.conf" and should have been "res_http_media_cache.conf".

channels/pjsip/dialplan_functions_doc.xml
main/bucket.c
main/named_acl.c
res/res_geolocation/geoloc_doc.xml
res/res_http_media_cache.c

index adf5a6a8b3063ee26a8a77123178e19b7e9ac47c..eb849f54e274fea6b09b272d41c4f9aa5c49787b 100644 (file)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE docs SYSTEM "appdocsxml.dtd">
-<docs>
+<docs xmlns:xi="http://www.w3.org/2001/XInclude">
        <application name="PJSIPHangup" language="en_US">
                <synopsis>
                        Hangup an incoming PJSIP channel with a SIP response code
index 883bbb15ec3afa48db36457ca25fc836aeeeec63..b4152347a9be102cdc7ae2989ac1e764adc5c04a 100644 (file)
        <support_level>core</support_level>
  ***/
 
-/*** DOCUMENTATION
-        <configInfo name="core" language="en_US">
-                <synopsis>Bucket file API</synopsis>
-                <configFile name="bucket">
-                        <configObject name="bucket">
-                                <configOption name="scheme">
-                                        <synopsis>Scheme in use for bucket</synopsis>
-                                </configOption>
-                                <configOption name="created">
-                                        <synopsis>Time at which the bucket was created</synopsis>
-                                </configOption>
-                                <configOption name="modified">
-                                        <synopsis>Time at which the bucket was last modified</synopsis>
-                                </configOption>
-                        </configObject>
-                        <configObject name="file">
-                                <configOption name="scheme">
-                                        <synopsis>Scheme in use for file</synopsis>
-                                </configOption>
-                                <configOption name="created">
-                                        <synopsis>Time at which the file was created</synopsis>
-                                </configOption>
-                                <configOption name="modified">
-                                        <synopsis>Time at which the file was last modified</synopsis>
-                                </configOption>
-                        </configObject>
-                </configFile>
-        </configInfo>
-***/
-
 #include "asterisk.h"
 
 #ifdef HAVE_URIPARSER
@@ -982,14 +952,14 @@ int ast_bucket_init(void)
                return -1;
        }
 
-       if (ast_sorcery_object_register(bucket_sorcery, "bucket", bucket_alloc, NULL, NULL)) {
+       if (ast_sorcery_internal_object_register(bucket_sorcery, "bucket", bucket_alloc, NULL, NULL)) {
                ast_log(LOG_ERROR, "Failed to register 'bucket' object type in Bucket sorcery\n");
                return -1;
        }
 
-       ast_sorcery_object_field_register(bucket_sorcery, "bucket", "scheme", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_bucket, scheme));
-       ast_sorcery_object_field_register_custom(bucket_sorcery, "bucket", "created", "", timeval_str2struct, timeval_struct2str, NULL, 0, FLDSET(struct ast_bucket, created));
-       ast_sorcery_object_field_register_custom(bucket_sorcery, "bucket", "modified", "", timeval_str2struct, timeval_struct2str, NULL, 0, FLDSET(struct ast_bucket, modified));
+       ast_sorcery_object_field_register_nodoc(bucket_sorcery, "bucket", "scheme", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_bucket, scheme));
+       ast_sorcery_object_field_register_custom_nodoc(bucket_sorcery, "bucket", "created", "", timeval_str2struct, timeval_struct2str, NULL, 0, FLDSET(struct ast_bucket, created));
+       ast_sorcery_object_field_register_custom_nodoc(bucket_sorcery, "bucket", "modified", "", timeval_str2struct, timeval_struct2str, NULL, 0, FLDSET(struct ast_bucket, modified));
        ast_sorcery_object_set_copy_handler(bucket_sorcery, "bucket", bucket_copy_handler);
 
        if (ast_sorcery_apply_default(bucket_sorcery, "file", "bucket_file", NULL) == AST_SORCERY_APPLY_FAIL) {
@@ -997,14 +967,14 @@ int ast_bucket_init(void)
                return -1;
        }
 
-       if (ast_sorcery_object_register(bucket_sorcery, "file", bucket_file_alloc, NULL, NULL)) {
+       if (ast_sorcery_internal_object_register(bucket_sorcery, "file", bucket_file_alloc, NULL, NULL)) {
                ast_log(LOG_ERROR, "Failed to register 'file' object type in Bucket sorcery\n");
                return -1;
        }
 
-       ast_sorcery_object_field_register(bucket_sorcery, "file", "scheme", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_bucket_file, scheme));
-       ast_sorcery_object_field_register_custom(bucket_sorcery, "file", "created", "", timeval_str2struct, timeval_struct2str, NULL, 0, FLDSET(struct ast_bucket_file, created));
-       ast_sorcery_object_field_register_custom(bucket_sorcery, "file", "modified", "", timeval_str2struct, timeval_struct2str, NULL, 0, FLDSET(struct ast_bucket_file, modified));
+       ast_sorcery_object_field_register_nodoc(bucket_sorcery, "file", "scheme", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_bucket_file, scheme));
+       ast_sorcery_object_field_register_custom_nodoc(bucket_sorcery, "file", "created", "", timeval_str2struct, timeval_struct2str, NULL, 0, FLDSET(struct ast_bucket_file, created));
+       ast_sorcery_object_field_register_custom_nodoc(bucket_sorcery, "file", "modified", "", timeval_str2struct, timeval_struct2str, NULL, 0, FLDSET(struct ast_bucket_file, modified));
        ast_sorcery_object_set_copy_handler(bucket_sorcery, "file", bucket_file_copy_handler);
 
        return 0;
index 0a4100c499bc7124288b441f87740d060b9e2647..134cb34c7af5ad28cd1567ce1bed7c8cb11e0ac2 100644 (file)
@@ -51,7 +51,7 @@
 
 /*** DOCUMENTATION
        <configInfo name="named_acl" language="en_US">
-               <configFile name="named_acl.conf">
+               <configFile name="acl.conf">
                        <configObject name="named_acl">
                                <synopsis>Options for configuring a named ACL</synopsis>
                                <configOption name="permit">
index b5713362f2405294487c26a15ea1fd436b486a45..f6fd3d8c673dd2ee87c7b722bd8689cf67afcfde 100644 (file)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE docs SYSTEM "appdocsxml.dtd">
-<docs>
+<docs xmlns:xi="http://www.w3.org/2001/XInclude">
        <configInfo name="res_geolocation" language="en_US">
                <synopsis>Core Geolocation Support</synopsis>
                <configFile name="geolocation.conf">
index 73386febef6817986399c3e603331948cf96ce88..92e49ccbb1f7cca961c6623b5da1c0e1d08f7cea 100644 (file)
@@ -34,7 +34,7 @@
 /*** DOCUMENTATION
        <configInfo name="res_http_media_cache" language="en_US">
                <synopsis>HTTP media cache</synopsis>
-               <configFile name="http_media_cache.conf">
+               <configFile name="res_http_media_cache.conf">
                        <configObject name="general">
                                <synopsis>General configuration</synopsis>
                                <configOption name="timeout_secs" default="180">