Skip to content

Commit

Permalink
Remove unresolvable references in docs (#1)
Browse files Browse the repository at this point in the history
* Remove unresolvable references in docs

* Regenerate bindings (#2)

Co-authored-by: Octogonapus <[email protected]>

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
Octogonapus and github-actions[bot] authored May 9, 2024
1 parent 61bf7eb commit 781a798
Show file tree
Hide file tree
Showing 14 changed files with 67 additions and 52 deletions.
15 changes: 15 additions & 0 deletions gen/generator.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand Down
8 changes: 4 additions & 4 deletions lib/aarch64-apple-darwin20.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions lib/aarch64-linux-gnu.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions lib/aarch64-linux-musl.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions lib/armv7l-linux-gnueabihf.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions lib/armv7l-linux-musleabihf.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions lib/i686-linux-gnu.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions lib/i686-linux-musl.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions lib/powerpc64le-linux-gnu.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading

0 comments on commit 781a798

Please sign in to comment.