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 9edd88a commit 01fc3e2
Show file tree
Hide file tree
Showing 14 changed files with 32 additions and 26 deletions.
6 changes: 6 additions & 0 deletions gen/generator.jl
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ function get_docs(node, docs)
end
end

# fix other random stuff
for doci in eachindex(docs)
# fix some code that gets bogus references inserted
docs[doci] = replace(docs[doci], "struct [`aws_string`](@ref) *" => "`struct aws_string *`")
end

return docs
end

Expand Down
4 changes: 2 additions & 2 deletions lib/aarch64-apple-darwin20.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const aws_iotdevice_defender_get_number_list_fn = Cvoid
"""
User callback type invoked to retrieve a string list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand All @@ -105,7 +105,7 @@ const aws_iotdevice_defender_get_string_list_fn = Cvoid
"""
User callback type invoked to retrieve an ip list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand Down
4 changes: 2 additions & 2 deletions lib/aarch64-linux-gnu.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const aws_iotdevice_defender_get_number_list_fn = Cvoid
"""
User callback type invoked to retrieve a string list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand All @@ -105,7 +105,7 @@ const aws_iotdevice_defender_get_string_list_fn = Cvoid
"""
User callback type invoked to retrieve an ip list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand Down
4 changes: 2 additions & 2 deletions lib/aarch64-linux-musl.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const aws_iotdevice_defender_get_number_list_fn = Cvoid
"""
User callback type invoked to retrieve a string list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand All @@ -105,7 +105,7 @@ const aws_iotdevice_defender_get_string_list_fn = Cvoid
"""
User callback type invoked to retrieve an ip list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand Down
4 changes: 2 additions & 2 deletions lib/armv7l-linux-gnueabihf.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const aws_iotdevice_defender_get_number_list_fn = Cvoid
"""
User callback type invoked to retrieve a string list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand All @@ -105,7 +105,7 @@ const aws_iotdevice_defender_get_string_list_fn = Cvoid
"""
User callback type invoked to retrieve an ip list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand Down
4 changes: 2 additions & 2 deletions lib/armv7l-linux-musleabihf.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const aws_iotdevice_defender_get_number_list_fn = Cvoid
"""
User callback type invoked to retrieve a string list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand All @@ -105,7 +105,7 @@ const aws_iotdevice_defender_get_string_list_fn = Cvoid
"""
User callback type invoked to retrieve an ip list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand Down
4 changes: 2 additions & 2 deletions lib/i686-linux-gnu.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const aws_iotdevice_defender_get_number_list_fn = Cvoid
"""
User callback type invoked to retrieve a string list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand All @@ -105,7 +105,7 @@ const aws_iotdevice_defender_get_string_list_fn = Cvoid
"""
User callback type invoked to retrieve an ip list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand Down
4 changes: 2 additions & 2 deletions lib/i686-linux-musl.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const aws_iotdevice_defender_get_number_list_fn = Cvoid
"""
User callback type invoked to retrieve a string list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand All @@ -105,7 +105,7 @@ const aws_iotdevice_defender_get_string_list_fn = Cvoid
"""
User callback type invoked to retrieve an ip list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand Down
4 changes: 2 additions & 2 deletions lib/powerpc64le-linux-gnu.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const aws_iotdevice_defender_get_number_list_fn = Cvoid
"""
User callback type invoked to retrieve a string list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand All @@ -105,7 +105,7 @@ const aws_iotdevice_defender_get_string_list_fn = Cvoid
"""
User callback type invoked to retrieve an ip list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand Down
4 changes: 2 additions & 2 deletions lib/x86_64-apple-darwin14.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const aws_iotdevice_defender_get_number_list_fn = Cvoid
"""
User callback type invoked to retrieve a string list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand All @@ -105,7 +105,7 @@ const aws_iotdevice_defender_get_string_list_fn = Cvoid
"""
User callback type invoked to retrieve an ip list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand Down
4 changes: 2 additions & 2 deletions lib/x86_64-linux-gnu.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const aws_iotdevice_defender_get_number_list_fn = Cvoid
"""
User callback type invoked to retrieve a string list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand All @@ -105,7 +105,7 @@ const aws_iotdevice_defender_get_string_list_fn = Cvoid
"""
User callback type invoked to retrieve an ip list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand Down
4 changes: 2 additions & 2 deletions lib/x86_64-linux-musl.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const aws_iotdevice_defender_get_number_list_fn = Cvoid
"""
User callback type invoked to retrieve a string list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand All @@ -105,7 +105,7 @@ const aws_iotdevice_defender_get_string_list_fn = Cvoid
"""
User callback type invoked to retrieve an ip list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand Down
4 changes: 2 additions & 2 deletions lib/x86_64-unknown-freebsd13.2.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const aws_iotdevice_defender_get_number_list_fn = Cvoid
"""
User callback type invoked to retrieve a string list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand All @@ -105,7 +105,7 @@ const aws_iotdevice_defender_get_string_list_fn = Cvoid
"""
User callback type invoked to retrieve an ip list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand Down
4 changes: 2 additions & 2 deletions lib/x86_64-w64-mingw32.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const aws_iotdevice_defender_get_number_list_fn = Cvoid
"""
User callback type invoked to retrieve a string list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand All @@ -105,7 +105,7 @@ const aws_iotdevice_defender_get_string_list_fn = Cvoid
"""
User callback type invoked to retrieve an ip list custom metric
List provided will already be initialized and caller must push items into the list of type (struct [`aws_string`](@ref) *). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
List provided will already be initialized and caller must push items into the list of type (`struct aws_string *`). String allocated that are placed into the list are destroyed by the defender task after it is done with the list.
returns: AWS\\_OP\\_SUCCESS if the custom metric was successfully added to the task config
"""
Expand Down

0 comments on commit 01fc3e2

Please sign in to comment.