From 114fa12f05cbd895941fff4372dc5e63b5652886 Mon Sep 17 00:00:00 2001 From: George Joseph Date: Wed, 15 Jan 2025 16:19:27 -0700 Subject: [PATCH] docs: Various XML fixes * 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 | 2 +- main/bucket.c | 46 ++++------------------- main/named_acl.c | 2 +- res/res_geolocation/geoloc_doc.xml | 2 +- res/res_http_media_cache.c | 2 +- 5 files changed, 12 insertions(+), 42 deletions(-) diff --git a/channels/pjsip/dialplan_functions_doc.xml b/channels/pjsip/dialplan_functions_doc.xml index adf5a6a8b3..eb849f54e2 100644 --- a/channels/pjsip/dialplan_functions_doc.xml +++ b/channels/pjsip/dialplan_functions_doc.xml @@ -1,6 +1,6 @@ - + Hangup an incoming PJSIP channel with a SIP response code diff --git a/main/bucket.c b/main/bucket.c index 883bbb15ec..b4152347a9 100644 --- a/main/bucket.c +++ b/main/bucket.c @@ -28,36 +28,6 @@ core ***/ -/*** DOCUMENTATION - - Bucket file API - - - - Scheme in use for bucket - - - Time at which the bucket was created - - - Time at which the bucket was last modified - - - - - Scheme in use for file - - - Time at which the file was created - - - Time at which the file was last modified - - - - -***/ - #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; diff --git a/main/named_acl.c b/main/named_acl.c index 0a4100c499..134cb34c7a 100644 --- a/main/named_acl.c +++ b/main/named_acl.c @@ -51,7 +51,7 @@ /*** DOCUMENTATION - + Options for configuring a named ACL diff --git a/res/res_geolocation/geoloc_doc.xml b/res/res_geolocation/geoloc_doc.xml index b5713362f2..f6fd3d8c67 100644 --- a/res/res_geolocation/geoloc_doc.xml +++ b/res/res_geolocation/geoloc_doc.xml @@ -1,6 +1,6 @@ - + Core Geolocation Support diff --git a/res/res_http_media_cache.c b/res/res_http_media_cache.c index 73386febef..92e49ccbb1 100644 --- a/res/res_http_media_cache.c +++ b/res/res_http_media_cache.c @@ -34,7 +34,7 @@ /*** DOCUMENTATION HTTP media cache - + General configuration