From 781a7988e715a05d93de263111e169eff10c0624 Mon Sep 17 00:00:00 2001 From: Octogonapus Date: Thu, 9 May 2024 18:51:03 -0400 Subject: [PATCH] Remove unresolvable references in docs (#1) * Remove unresolvable references in docs * Regenerate bindings (#2) Co-authored-by: Octogonapus <4064722+Octogonapus@users.noreply.github.com> --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- gen/generator.jl | 15 +++++++++++++++ lib/aarch64-apple-darwin20.jl | 8 ++++---- lib/aarch64-linux-gnu.jl | 8 ++++---- lib/aarch64-linux-musl.jl | 8 ++++---- lib/armv7l-linux-gnueabihf.jl | 8 ++++---- lib/armv7l-linux-musleabihf.jl | 8 ++++---- lib/i686-linux-gnu.jl | 8 ++++---- lib/i686-linux-musl.jl | 8 ++++---- lib/powerpc64le-linux-gnu.jl | 8 ++++---- lib/x86_64-apple-darwin14.jl | 8 ++++---- lib/x86_64-linux-gnu.jl | 8 ++++---- lib/x86_64-linux-musl.jl | 8 ++++---- lib/x86_64-unknown-freebsd13.2.jl | 8 ++++---- lib/x86_64-w64-mingw32.jl | 8 ++++---- 14 files changed, 67 insertions(+), 52 deletions(-) diff --git a/gen/generator.jl b/gen/generator.jl index a09793d..2781079 100644 --- a/gen/generator.jl +++ b/gen/generator.jl @@ -9,6 +9,14 @@ using LibAwsCal cd(@__DIR__) +const refs_to_remove = ( + "AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT", + "AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT", + "AWS_HTTP_SERVER_OPTIONS_INIT", + "aws_tls_connection_options", + "aws_socket_options", +) + # This is called if the docs generated from the extract_c_comment_style method did not generate any lines. # We need to generate at least some docs so that cross-references work with Documenter.jl. function get_docs(node, docs) @@ -23,6 +31,13 @@ function get_docs(node, docs) return ["Documentation not found."] end + # remove references to things which don't exist because it causes Documenter.jl's cross_references check to fail + for ref in refs_to_remove + for doci in eachindex(docs) + docs[doci] = replace(docs[doci], "[`$ref`](@ref)" => "`$ref`") + end + end + return docs end diff --git a/lib/aarch64-apple-darwin20.jl b/lib/aarch64-apple-darwin20.jl index bc5dd9a..9d08e3d 100644 --- a/lib/aarch64-apple-darwin20.jl +++ b/lib/aarch64-apple-darwin20.jl @@ -209,7 +209,7 @@ end """ aws_http_client_connection_options -Options for creating an HTTP client connection. Initialize with [`AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP client connection. Initialize with `AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_client_connection_options self_size::Csize_t @@ -260,7 +260,7 @@ mutable struct aws_http_connection end Users must release the connection when they are done with it. The connection's memory cannot be reclaimed until this is done. If the connection was not already shutting down, it will be shut down. -Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg [`aws_tls_connection_options`](@ref), [`aws_socket_options`](@ref)) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. +Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg `aws_tls_connection_options`, `aws_socket_options`) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. ### Prototype ```c @@ -3046,7 +3046,7 @@ const aws_http_server_on_destroy_fn = Cvoid """ aws_http_server_options -Options for creating an HTTP server. Initialize with [`AWS_HTTP_SERVER_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP server. Initialize with `AWS_HTTP_SERVER_OPTIONS_INIT` to set default values. """ struct aws_http_server_options self_size::Csize_t @@ -3077,7 +3077,7 @@ const aws_http_on_server_connection_shutdown_fn = Cvoid """ aws_http_server_connection_options -Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with [`AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with `AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_server_connection_options self_size::Csize_t diff --git a/lib/aarch64-linux-gnu.jl b/lib/aarch64-linux-gnu.jl index 731a717..6e5a841 100644 --- a/lib/aarch64-linux-gnu.jl +++ b/lib/aarch64-linux-gnu.jl @@ -209,7 +209,7 @@ end """ aws_http_client_connection_options -Options for creating an HTTP client connection. Initialize with [`AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP client connection. Initialize with `AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_client_connection_options self_size::Csize_t @@ -260,7 +260,7 @@ mutable struct aws_http_connection end Users must release the connection when they are done with it. The connection's memory cannot be reclaimed until this is done. If the connection was not already shutting down, it will be shut down. -Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg [`aws_tls_connection_options`](@ref), [`aws_socket_options`](@ref)) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. +Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg `aws_tls_connection_options`, `aws_socket_options`) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. ### Prototype ```c @@ -3046,7 +3046,7 @@ const aws_http_server_on_destroy_fn = Cvoid """ aws_http_server_options -Options for creating an HTTP server. Initialize with [`AWS_HTTP_SERVER_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP server. Initialize with `AWS_HTTP_SERVER_OPTIONS_INIT` to set default values. """ struct aws_http_server_options self_size::Csize_t @@ -3077,7 +3077,7 @@ const aws_http_on_server_connection_shutdown_fn = Cvoid """ aws_http_server_connection_options -Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with [`AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with `AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_server_connection_options self_size::Csize_t diff --git a/lib/aarch64-linux-musl.jl b/lib/aarch64-linux-musl.jl index 799f2f5..ed3981f 100644 --- a/lib/aarch64-linux-musl.jl +++ b/lib/aarch64-linux-musl.jl @@ -209,7 +209,7 @@ end """ aws_http_client_connection_options -Options for creating an HTTP client connection. Initialize with [`AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP client connection. Initialize with `AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_client_connection_options self_size::Csize_t @@ -260,7 +260,7 @@ mutable struct aws_http_connection end Users must release the connection when they are done with it. The connection's memory cannot be reclaimed until this is done. If the connection was not already shutting down, it will be shut down. -Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg [`aws_tls_connection_options`](@ref), [`aws_socket_options`](@ref)) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. +Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg `aws_tls_connection_options`, `aws_socket_options`) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. ### Prototype ```c @@ -3046,7 +3046,7 @@ const aws_http_server_on_destroy_fn = Cvoid """ aws_http_server_options -Options for creating an HTTP server. Initialize with [`AWS_HTTP_SERVER_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP server. Initialize with `AWS_HTTP_SERVER_OPTIONS_INIT` to set default values. """ struct aws_http_server_options self_size::Csize_t @@ -3077,7 +3077,7 @@ const aws_http_on_server_connection_shutdown_fn = Cvoid """ aws_http_server_connection_options -Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with [`AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with `AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_server_connection_options self_size::Csize_t diff --git a/lib/armv7l-linux-gnueabihf.jl b/lib/armv7l-linux-gnueabihf.jl index ec02be4..e1dd342 100644 --- a/lib/armv7l-linux-gnueabihf.jl +++ b/lib/armv7l-linux-gnueabihf.jl @@ -209,7 +209,7 @@ end """ aws_http_client_connection_options -Options for creating an HTTP client connection. Initialize with [`AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP client connection. Initialize with `AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_client_connection_options self_size::Csize_t @@ -260,7 +260,7 @@ mutable struct aws_http_connection end Users must release the connection when they are done with it. The connection's memory cannot be reclaimed until this is done. If the connection was not already shutting down, it will be shut down. -Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg [`aws_tls_connection_options`](@ref), [`aws_socket_options`](@ref)) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. +Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg `aws_tls_connection_options`, `aws_socket_options`) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. ### Prototype ```c @@ -3046,7 +3046,7 @@ const aws_http_server_on_destroy_fn = Cvoid """ aws_http_server_options -Options for creating an HTTP server. Initialize with [`AWS_HTTP_SERVER_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP server. Initialize with `AWS_HTTP_SERVER_OPTIONS_INIT` to set default values. """ struct aws_http_server_options self_size::Csize_t @@ -3077,7 +3077,7 @@ const aws_http_on_server_connection_shutdown_fn = Cvoid """ aws_http_server_connection_options -Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with [`AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with `AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_server_connection_options self_size::Csize_t diff --git a/lib/armv7l-linux-musleabihf.jl b/lib/armv7l-linux-musleabihf.jl index 4e7206c..4c3c1b7 100644 --- a/lib/armv7l-linux-musleabihf.jl +++ b/lib/armv7l-linux-musleabihf.jl @@ -209,7 +209,7 @@ end """ aws_http_client_connection_options -Options for creating an HTTP client connection. Initialize with [`AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP client connection. Initialize with `AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_client_connection_options self_size::Csize_t @@ -260,7 +260,7 @@ mutable struct aws_http_connection end Users must release the connection when they are done with it. The connection's memory cannot be reclaimed until this is done. If the connection was not already shutting down, it will be shut down. -Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg [`aws_tls_connection_options`](@ref), [`aws_socket_options`](@ref)) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. +Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg `aws_tls_connection_options`, `aws_socket_options`) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. ### Prototype ```c @@ -3046,7 +3046,7 @@ const aws_http_server_on_destroy_fn = Cvoid """ aws_http_server_options -Options for creating an HTTP server. Initialize with [`AWS_HTTP_SERVER_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP server. Initialize with `AWS_HTTP_SERVER_OPTIONS_INIT` to set default values. """ struct aws_http_server_options self_size::Csize_t @@ -3077,7 +3077,7 @@ const aws_http_on_server_connection_shutdown_fn = Cvoid """ aws_http_server_connection_options -Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with [`AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with `AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_server_connection_options self_size::Csize_t diff --git a/lib/i686-linux-gnu.jl b/lib/i686-linux-gnu.jl index 50a9fd0..2093881 100644 --- a/lib/i686-linux-gnu.jl +++ b/lib/i686-linux-gnu.jl @@ -209,7 +209,7 @@ end """ aws_http_client_connection_options -Options for creating an HTTP client connection. Initialize with [`AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP client connection. Initialize with `AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_client_connection_options self_size::Csize_t @@ -260,7 +260,7 @@ mutable struct aws_http_connection end Users must release the connection when they are done with it. The connection's memory cannot be reclaimed until this is done. If the connection was not already shutting down, it will be shut down. -Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg [`aws_tls_connection_options`](@ref), [`aws_socket_options`](@ref)) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. +Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg `aws_tls_connection_options`, `aws_socket_options`) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. ### Prototype ```c @@ -3046,7 +3046,7 @@ const aws_http_server_on_destroy_fn = Cvoid """ aws_http_server_options -Options for creating an HTTP server. Initialize with [`AWS_HTTP_SERVER_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP server. Initialize with `AWS_HTTP_SERVER_OPTIONS_INIT` to set default values. """ struct aws_http_server_options self_size::Csize_t @@ -3077,7 +3077,7 @@ const aws_http_on_server_connection_shutdown_fn = Cvoid """ aws_http_server_connection_options -Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with [`AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with `AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_server_connection_options self_size::Csize_t diff --git a/lib/i686-linux-musl.jl b/lib/i686-linux-musl.jl index 4e7206c..4c3c1b7 100644 --- a/lib/i686-linux-musl.jl +++ b/lib/i686-linux-musl.jl @@ -209,7 +209,7 @@ end """ aws_http_client_connection_options -Options for creating an HTTP client connection. Initialize with [`AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP client connection. Initialize with `AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_client_connection_options self_size::Csize_t @@ -260,7 +260,7 @@ mutable struct aws_http_connection end Users must release the connection when they are done with it. The connection's memory cannot be reclaimed until this is done. If the connection was not already shutting down, it will be shut down. -Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg [`aws_tls_connection_options`](@ref), [`aws_socket_options`](@ref)) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. +Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg `aws_tls_connection_options`, `aws_socket_options`) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. ### Prototype ```c @@ -3046,7 +3046,7 @@ const aws_http_server_on_destroy_fn = Cvoid """ aws_http_server_options -Options for creating an HTTP server. Initialize with [`AWS_HTTP_SERVER_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP server. Initialize with `AWS_HTTP_SERVER_OPTIONS_INIT` to set default values. """ struct aws_http_server_options self_size::Csize_t @@ -3077,7 +3077,7 @@ const aws_http_on_server_connection_shutdown_fn = Cvoid """ aws_http_server_connection_options -Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with [`AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with `AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_server_connection_options self_size::Csize_t diff --git a/lib/powerpc64le-linux-gnu.jl b/lib/powerpc64le-linux-gnu.jl index ccbb306..81cfc55 100644 --- a/lib/powerpc64le-linux-gnu.jl +++ b/lib/powerpc64le-linux-gnu.jl @@ -209,7 +209,7 @@ end """ aws_http_client_connection_options -Options for creating an HTTP client connection. Initialize with [`AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP client connection. Initialize with `AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_client_connection_options self_size::Csize_t @@ -260,7 +260,7 @@ mutable struct aws_http_connection end Users must release the connection when they are done with it. The connection's memory cannot be reclaimed until this is done. If the connection was not already shutting down, it will be shut down. -Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg [`aws_tls_connection_options`](@ref), [`aws_socket_options`](@ref)) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. +Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg `aws_tls_connection_options`, `aws_socket_options`) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. ### Prototype ```c @@ -3046,7 +3046,7 @@ const aws_http_server_on_destroy_fn = Cvoid """ aws_http_server_options -Options for creating an HTTP server. Initialize with [`AWS_HTTP_SERVER_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP server. Initialize with `AWS_HTTP_SERVER_OPTIONS_INIT` to set default values. """ struct aws_http_server_options self_size::Csize_t @@ -3077,7 +3077,7 @@ const aws_http_on_server_connection_shutdown_fn = Cvoid """ aws_http_server_connection_options -Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with [`AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with `AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_server_connection_options self_size::Csize_t diff --git a/lib/x86_64-apple-darwin14.jl b/lib/x86_64-apple-darwin14.jl index bc5dd9a..9d08e3d 100644 --- a/lib/x86_64-apple-darwin14.jl +++ b/lib/x86_64-apple-darwin14.jl @@ -209,7 +209,7 @@ end """ aws_http_client_connection_options -Options for creating an HTTP client connection. Initialize with [`AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP client connection. Initialize with `AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_client_connection_options self_size::Csize_t @@ -260,7 +260,7 @@ mutable struct aws_http_connection end Users must release the connection when they are done with it. The connection's memory cannot be reclaimed until this is done. If the connection was not already shutting down, it will be shut down. -Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg [`aws_tls_connection_options`](@ref), [`aws_socket_options`](@ref)) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. +Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg `aws_tls_connection_options`, `aws_socket_options`) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. ### Prototype ```c @@ -3046,7 +3046,7 @@ const aws_http_server_on_destroy_fn = Cvoid """ aws_http_server_options -Options for creating an HTTP server. Initialize with [`AWS_HTTP_SERVER_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP server. Initialize with `AWS_HTTP_SERVER_OPTIONS_INIT` to set default values. """ struct aws_http_server_options self_size::Csize_t @@ -3077,7 +3077,7 @@ const aws_http_on_server_connection_shutdown_fn = Cvoid """ aws_http_server_connection_options -Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with [`AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with `AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_server_connection_options self_size::Csize_t diff --git a/lib/x86_64-linux-gnu.jl b/lib/x86_64-linux-gnu.jl index ccbb306..81cfc55 100644 --- a/lib/x86_64-linux-gnu.jl +++ b/lib/x86_64-linux-gnu.jl @@ -209,7 +209,7 @@ end """ aws_http_client_connection_options -Options for creating an HTTP client connection. Initialize with [`AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP client connection. Initialize with `AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_client_connection_options self_size::Csize_t @@ -260,7 +260,7 @@ mutable struct aws_http_connection end Users must release the connection when they are done with it. The connection's memory cannot be reclaimed until this is done. If the connection was not already shutting down, it will be shut down. -Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg [`aws_tls_connection_options`](@ref), [`aws_socket_options`](@ref)) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. +Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg `aws_tls_connection_options`, `aws_socket_options`) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. ### Prototype ```c @@ -3046,7 +3046,7 @@ const aws_http_server_on_destroy_fn = Cvoid """ aws_http_server_options -Options for creating an HTTP server. Initialize with [`AWS_HTTP_SERVER_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP server. Initialize with `AWS_HTTP_SERVER_OPTIONS_INIT` to set default values. """ struct aws_http_server_options self_size::Csize_t @@ -3077,7 +3077,7 @@ const aws_http_on_server_connection_shutdown_fn = Cvoid """ aws_http_server_connection_options -Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with [`AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with `AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_server_connection_options self_size::Csize_t diff --git a/lib/x86_64-linux-musl.jl b/lib/x86_64-linux-musl.jl index 799f2f5..ed3981f 100644 --- a/lib/x86_64-linux-musl.jl +++ b/lib/x86_64-linux-musl.jl @@ -209,7 +209,7 @@ end """ aws_http_client_connection_options -Options for creating an HTTP client connection. Initialize with [`AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP client connection. Initialize with `AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_client_connection_options self_size::Csize_t @@ -260,7 +260,7 @@ mutable struct aws_http_connection end Users must release the connection when they are done with it. The connection's memory cannot be reclaimed until this is done. If the connection was not already shutting down, it will be shut down. -Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg [`aws_tls_connection_options`](@ref), [`aws_socket_options`](@ref)) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. +Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg `aws_tls_connection_options`, `aws_socket_options`) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. ### Prototype ```c @@ -3046,7 +3046,7 @@ const aws_http_server_on_destroy_fn = Cvoid """ aws_http_server_options -Options for creating an HTTP server. Initialize with [`AWS_HTTP_SERVER_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP server. Initialize with `AWS_HTTP_SERVER_OPTIONS_INIT` to set default values. """ struct aws_http_server_options self_size::Csize_t @@ -3077,7 +3077,7 @@ const aws_http_on_server_connection_shutdown_fn = Cvoid """ aws_http_server_connection_options -Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with [`AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with `AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_server_connection_options self_size::Csize_t diff --git a/lib/x86_64-unknown-freebsd13.2.jl b/lib/x86_64-unknown-freebsd13.2.jl index b62f370..bdc86fa 100644 --- a/lib/x86_64-unknown-freebsd13.2.jl +++ b/lib/x86_64-unknown-freebsd13.2.jl @@ -209,7 +209,7 @@ end """ aws_http_client_connection_options -Options for creating an HTTP client connection. Initialize with [`AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP client connection. Initialize with `AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_client_connection_options self_size::Csize_t @@ -260,7 +260,7 @@ mutable struct aws_http_connection end Users must release the connection when they are done with it. The connection's memory cannot be reclaimed until this is done. If the connection was not already shutting down, it will be shut down. -Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg [`aws_tls_connection_options`](@ref), [`aws_socket_options`](@ref)) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. +Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg `aws_tls_connection_options`, `aws_socket_options`) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. ### Prototype ```c @@ -3046,7 +3046,7 @@ const aws_http_server_on_destroy_fn = Cvoid """ aws_http_server_options -Options for creating an HTTP server. Initialize with [`AWS_HTTP_SERVER_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP server. Initialize with `AWS_HTTP_SERVER_OPTIONS_INIT` to set default values. """ struct aws_http_server_options self_size::Csize_t @@ -3077,7 +3077,7 @@ const aws_http_on_server_connection_shutdown_fn = Cvoid """ aws_http_server_connection_options -Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with [`AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with `AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_server_connection_options self_size::Csize_t diff --git a/lib/x86_64-w64-mingw32.jl b/lib/x86_64-w64-mingw32.jl index cb835cd..becf470 100644 --- a/lib/x86_64-w64-mingw32.jl +++ b/lib/x86_64-w64-mingw32.jl @@ -209,7 +209,7 @@ end """ aws_http_client_connection_options -Options for creating an HTTP client connection. Initialize with [`AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP client connection. Initialize with `AWS_HTTP_CLIENT_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_client_connection_options self_size::Csize_t @@ -260,7 +260,7 @@ mutable struct aws_http_connection end Users must release the connection when they are done with it. The connection's memory cannot be reclaimed until this is done. If the connection was not already shutting down, it will be shut down. -Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg [`aws_tls_connection_options`](@ref), [`aws_socket_options`](@ref)) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. +Users should always wait for the on\\_shutdown() callback to be called before releasing any data passed to the http\\_connection (Eg `aws_tls_connection_options`, `aws_socket_options`) otherwise there will be race conditions between http\\_connection shutdown tasks and memory release tasks, causing Segfaults. ### Prototype ```c @@ -3046,7 +3046,7 @@ const aws_http_server_on_destroy_fn = Cvoid """ aws_http_server_options -Options for creating an HTTP server. Initialize with [`AWS_HTTP_SERVER_OPTIONS_INIT`](@ref) to set default values. +Options for creating an HTTP server. Initialize with `AWS_HTTP_SERVER_OPTIONS_INIT` to set default values. """ struct aws_http_server_options self_size::Csize_t @@ -3077,7 +3077,7 @@ const aws_http_on_server_connection_shutdown_fn = Cvoid """ aws_http_server_connection_options -Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with [`AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT`](@ref) to set default values. +Options for configuring a server-side [`aws_http_connection`](@ref). Initialized with `AWS_HTTP_SERVER_CONNECTION_OPTIONS_INIT` to set default values. """ struct aws_http_server_connection_options self_size::Csize_t