Merge pull request #1 from JuliaServices/fix_docs

Remove unresolvable references in docs

gen/generator.jl

@@ -17,7 +17,9 @@ using LibAwsSdkutils
 
 cd(@__DIR__)
 
-const refs_to_remove = []
+const refs_to_remove = (
+    "aws_client_bootstrap",
+)
 
 # 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.

lib/aarch64-apple-darwin20.jl

@@ -165,7 +165,7 @@ end
 """
     aws_mqtt_connection_options
 
-host\\_name The server name to connect to. This resource may be freed immediately on return. port The port on the server to connect to client\\_id The clientid to place in the CONNECT packet. socket\\_options The socket options to pass to the [`aws_client_bootstrap`](@ref) functions. This is copied into the connection tls\\_options TLS settings to use when opening a connection. This is copied into the connection Pass NULL to connect without TLS (NOT RECOMMENDED) clean\\_session True to discard all server session data and start fresh keep\\_alive\\_time\\_secs The keep alive value to place in the CONNECT PACKET, a PING will automatically be sent at this interval as well. If you specify 0, defaults will be used and a ping will be sent once per 20 minutes. This duration must be longer than ping\\_timeout\\_ms. ping\\_timeout\\_ms Network connection is re-established if a ping response is not received within this amount of time (milliseconds). If you specify 0, a default value of 3 seconds is used. Alternatively, tcp keep-alive may be away to accomplish this in a more efficient (low-power) scenario, but keep-alive options may not work the same way on every platform and OS version. This duration must be shorter than keep\\_alive\\_time\\_secs. protocol\\_operation\\_timeout\\_ms Timeout when waiting for the response to some operation requires response by protocol. Set to zero to disable timeout. Otherwise, the operation will fail with error AWS\\_ERROR\\_MQTT\\_TIMEOUT if no response is received within this amount of time after the packet is written to the socket. The timer is reset if the connection is interrupted. It applied to PUBLISH (QoS>0) and UNSUBSCRIBE now. Note: While the MQTT 3 specification states that a broker MUST respond, some brokers are known to ignore publish packets in exceptional circumstances (e.g. AWS IoT Core will not respond if the publish quota is exceeded). on\\_connection\\_complete The callback to fire when the connection attempt completes user\\_data Passed to the userdata param of on\\_connection\\_complete
+host\\_name The server name to connect to. This resource may be freed immediately on return. port The port on the server to connect to client\\_id The clientid to place in the CONNECT packet. socket\\_options The socket options to pass to the `aws_client_bootstrap` functions. This is copied into the connection tls\\_options TLS settings to use when opening a connection. This is copied into the connection Pass NULL to connect without TLS (NOT RECOMMENDED) clean\\_session True to discard all server session data and start fresh keep\\_alive\\_time\\_secs The keep alive value to place in the CONNECT PACKET, a PING will automatically be sent at this interval as well. If you specify 0, defaults will be used and a ping will be sent once per 20 minutes. This duration must be longer than ping\\_timeout\\_ms. ping\\_timeout\\_ms Network connection is re-established if a ping response is not received within this amount of time (milliseconds). If you specify 0, a default value of 3 seconds is used. Alternatively, tcp keep-alive may be away to accomplish this in a more efficient (low-power) scenario, but keep-alive options may not work the same way on every platform and OS version. This duration must be shorter than keep\\_alive\\_time\\_secs. protocol\\_operation\\_timeout\\_ms Timeout when waiting for the response to some operation requires response by protocol. Set to zero to disable timeout. Otherwise, the operation will fail with error AWS\\_ERROR\\_MQTT\\_TIMEOUT if no response is received within this amount of time after the packet is written to the socket. The timer is reset if the connection is interrupted. It applied to PUBLISH (QoS>0) and UNSUBSCRIBE now. Note: While the MQTT 3 specification states that a broker MUST respond, some brokers are known to ignore publish packets in exceptional circumstances (e.g. AWS IoT Core will not respond if the publish quota is exceeded). on\\_connection\\_complete The callback to fire when the connection attempt completes user\\_data Passed to the userdata param of on\\_connection\\_complete
 """
 struct aws_mqtt_connection_options
     host_name::aws_byte_cursor

lib/aarch64-linux-gnu.jl

@@ -165,7 +165,7 @@ end
 """
     aws_mqtt_connection_options
 
-host\\_name The server name to connect to. This resource may be freed immediately on return. port The port on the server to connect to client\\_id The clientid to place in the CONNECT packet. socket\\_options The socket options to pass to the [`aws_client_bootstrap`](@ref) functions. This is copied into the connection tls\\_options TLS settings to use when opening a connection. This is copied into the connection Pass NULL to connect without TLS (NOT RECOMMENDED) clean\\_session True to discard all server session data and start fresh keep\\_alive\\_time\\_secs The keep alive value to place in the CONNECT PACKET, a PING will automatically be sent at this interval as well. If you specify 0, defaults will be used and a ping will be sent once per 20 minutes. This duration must be longer than ping\\_timeout\\_ms. ping\\_timeout\\_ms Network connection is re-established if a ping response is not received within this amount of time (milliseconds). If you specify 0, a default value of 3 seconds is used. Alternatively, tcp keep-alive may be away to accomplish this in a more efficient (low-power) scenario, but keep-alive options may not work the same way on every platform and OS version. This duration must be shorter than keep\\_alive\\_time\\_secs. protocol\\_operation\\_timeout\\_ms Timeout when waiting for the response to some operation requires response by protocol. Set to zero to disable timeout. Otherwise, the operation will fail with error AWS\\_ERROR\\_MQTT\\_TIMEOUT if no response is received within this amount of time after the packet is written to the socket. The timer is reset if the connection is interrupted. It applied to PUBLISH (QoS>0) and UNSUBSCRIBE now. Note: While the MQTT 3 specification states that a broker MUST respond, some brokers are known to ignore publish packets in exceptional circumstances (e.g. AWS IoT Core will not respond if the publish quota is exceeded). on\\_connection\\_complete The callback to fire when the connection attempt completes user\\_data Passed to the userdata param of on\\_connection\\_complete
+host\\_name The server name to connect to. This resource may be freed immediately on return. port The port on the server to connect to client\\_id The clientid to place in the CONNECT packet. socket\\_options The socket options to pass to the `aws_client_bootstrap` functions. This is copied into the connection tls\\_options TLS settings to use when opening a connection. This is copied into the connection Pass NULL to connect without TLS (NOT RECOMMENDED) clean\\_session True to discard all server session data and start fresh keep\\_alive\\_time\\_secs The keep alive value to place in the CONNECT PACKET, a PING will automatically be sent at this interval as well. If you specify 0, defaults will be used and a ping will be sent once per 20 minutes. This duration must be longer than ping\\_timeout\\_ms. ping\\_timeout\\_ms Network connection is re-established if a ping response is not received within this amount of time (milliseconds). If you specify 0, a default value of 3 seconds is used. Alternatively, tcp keep-alive may be away to accomplish this in a more efficient (low-power) scenario, but keep-alive options may not work the same way on every platform and OS version. This duration must be shorter than keep\\_alive\\_time\\_secs. protocol\\_operation\\_timeout\\_ms Timeout when waiting for the response to some operation requires response by protocol. Set to zero to disable timeout. Otherwise, the operation will fail with error AWS\\_ERROR\\_MQTT\\_TIMEOUT if no response is received within this amount of time after the packet is written to the socket. The timer is reset if the connection is interrupted. It applied to PUBLISH (QoS>0) and UNSUBSCRIBE now. Note: While the MQTT 3 specification states that a broker MUST respond, some brokers are known to ignore publish packets in exceptional circumstances (e.g. AWS IoT Core will not respond if the publish quota is exceeded). on\\_connection\\_complete The callback to fire when the connection attempt completes user\\_data Passed to the userdata param of on\\_connection\\_complete
 """
 struct aws_mqtt_connection_options
     host_name::aws_byte_cursor

lib/aarch64-linux-musl.jl

@@ -165,7 +165,7 @@ end
 """
     aws_mqtt_connection_options
 
-host\\_name The server name to connect to. This resource may be freed immediately on return. port The port on the server to connect to client\\_id The clientid to place in the CONNECT packet. socket\\_options The socket options to pass to the [`aws_client_bootstrap`](@ref) functions. This is copied into the connection tls\\_options TLS settings to use when opening a connection. This is copied into the connection Pass NULL to connect without TLS (NOT RECOMMENDED) clean\\_session True to discard all server session data and start fresh keep\\_alive\\_time\\_secs The keep alive value to place in the CONNECT PACKET, a PING will automatically be sent at this interval as well. If you specify 0, defaults will be used and a ping will be sent once per 20 minutes. This duration must be longer than ping\\_timeout\\_ms. ping\\_timeout\\_ms Network connection is re-established if a ping response is not received within this amount of time (milliseconds). If you specify 0, a default value of 3 seconds is used. Alternatively, tcp keep-alive may be away to accomplish this in a more efficient (low-power) scenario, but keep-alive options may not work the same way on every platform and OS version. This duration must be shorter than keep\\_alive\\_time\\_secs. protocol\\_operation\\_timeout\\_ms Timeout when waiting for the response to some operation requires response by protocol. Set to zero to disable timeout. Otherwise, the operation will fail with error AWS\\_ERROR\\_MQTT\\_TIMEOUT if no response is received within this amount of time after the packet is written to the socket. The timer is reset if the connection is interrupted. It applied to PUBLISH (QoS>0) and UNSUBSCRIBE now. Note: While the MQTT 3 specification states that a broker MUST respond, some brokers are known to ignore publish packets in exceptional circumstances (e.g. AWS IoT Core will not respond if the publish quota is exceeded). on\\_connection\\_complete The callback to fire when the connection attempt completes user\\_data Passed to the userdata param of on\\_connection\\_complete
+host\\_name The server name to connect to. This resource may be freed immediately on return. port The port on the server to connect to client\\_id The clientid to place in the CONNECT packet. socket\\_options The socket options to pass to the `aws_client_bootstrap` functions. This is copied into the connection tls\\_options TLS settings to use when opening a connection. This is copied into the connection Pass NULL to connect without TLS (NOT RECOMMENDED) clean\\_session True to discard all server session data and start fresh keep\\_alive\\_time\\_secs The keep alive value to place in the CONNECT PACKET, a PING will automatically be sent at this interval as well. If you specify 0, defaults will be used and a ping will be sent once per 20 minutes. This duration must be longer than ping\\_timeout\\_ms. ping\\_timeout\\_ms Network connection is re-established if a ping response is not received within this amount of time (milliseconds). If you specify 0, a default value of 3 seconds is used. Alternatively, tcp keep-alive may be away to accomplish this in a more efficient (low-power) scenario, but keep-alive options may not work the same way on every platform and OS version. This duration must be shorter than keep\\_alive\\_time\\_secs. protocol\\_operation\\_timeout\\_ms Timeout when waiting for the response to some operation requires response by protocol. Set to zero to disable timeout. Otherwise, the operation will fail with error AWS\\_ERROR\\_MQTT\\_TIMEOUT if no response is received within this amount of time after the packet is written to the socket. The timer is reset if the connection is interrupted. It applied to PUBLISH (QoS>0) and UNSUBSCRIBE now. Note: While the MQTT 3 specification states that a broker MUST respond, some brokers are known to ignore publish packets in exceptional circumstances (e.g. AWS IoT Core will not respond if the publish quota is exceeded). on\\_connection\\_complete The callback to fire when the connection attempt completes user\\_data Passed to the userdata param of on\\_connection\\_complete
 """
 struct aws_mqtt_connection_options
     host_name::aws_byte_cursor

lib/armv7l-linux-gnueabihf.jl

@@ -165,7 +165,7 @@ end
 """
     aws_mqtt_connection_options
 
-host\\_name The server name to connect to. This resource may be freed immediately on return. port The port on the server to connect to client\\_id The clientid to place in the CONNECT packet. socket\\_options The socket options to pass to the [`aws_client_bootstrap`](@ref) functions. This is copied into the connection tls\\_options TLS settings to use when opening a connection. This is copied into the connection Pass NULL to connect without TLS (NOT RECOMMENDED) clean\\_session True to discard all server session data and start fresh keep\\_alive\\_time\\_secs The keep alive value to place in the CONNECT PACKET, a PING will automatically be sent at this interval as well. If you specify 0, defaults will be used and a ping will be sent once per 20 minutes. This duration must be longer than ping\\_timeout\\_ms. ping\\_timeout\\_ms Network connection is re-established if a ping response is not received within this amount of time (milliseconds). If you specify 0, a default value of 3 seconds is used. Alternatively, tcp keep-alive may be away to accomplish this in a more efficient (low-power) scenario, but keep-alive options may not work the same way on every platform and OS version. This duration must be shorter than keep\\_alive\\_time\\_secs. protocol\\_operation\\_timeout\\_ms Timeout when waiting for the response to some operation requires response by protocol. Set to zero to disable timeout. Otherwise, the operation will fail with error AWS\\_ERROR\\_MQTT\\_TIMEOUT if no response is received within this amount of time after the packet is written to the socket. The timer is reset if the connection is interrupted. It applied to PUBLISH (QoS>0) and UNSUBSCRIBE now. Note: While the MQTT 3 specification states that a broker MUST respond, some brokers are known to ignore publish packets in exceptional circumstances (e.g. AWS IoT Core will not respond if the publish quota is exceeded). on\\_connection\\_complete The callback to fire when the connection attempt completes user\\_data Passed to the userdata param of on\\_connection\\_complete
+host\\_name The server name to connect to. This resource may be freed immediately on return. port The port on the server to connect to client\\_id The clientid to place in the CONNECT packet. socket\\_options The socket options to pass to the `aws_client_bootstrap` functions. This is copied into the connection tls\\_options TLS settings to use when opening a connection. This is copied into the connection Pass NULL to connect without TLS (NOT RECOMMENDED) clean\\_session True to discard all server session data and start fresh keep\\_alive\\_time\\_secs The keep alive value to place in the CONNECT PACKET, a PING will automatically be sent at this interval as well. If you specify 0, defaults will be used and a ping will be sent once per 20 minutes. This duration must be longer than ping\\_timeout\\_ms. ping\\_timeout\\_ms Network connection is re-established if a ping response is not received within this amount of time (milliseconds). If you specify 0, a default value of 3 seconds is used. Alternatively, tcp keep-alive may be away to accomplish this in a more efficient (low-power) scenario, but keep-alive options may not work the same way on every platform and OS version. This duration must be shorter than keep\\_alive\\_time\\_secs. protocol\\_operation\\_timeout\\_ms Timeout when waiting for the response to some operation requires response by protocol. Set to zero to disable timeout. Otherwise, the operation will fail with error AWS\\_ERROR\\_MQTT\\_TIMEOUT if no response is received within this amount of time after the packet is written to the socket. The timer is reset if the connection is interrupted. It applied to PUBLISH (QoS>0) and UNSUBSCRIBE now. Note: While the MQTT 3 specification states that a broker MUST respond, some brokers are known to ignore publish packets in exceptional circumstances (e.g. AWS IoT Core will not respond if the publish quota is exceeded). on\\_connection\\_complete The callback to fire when the connection attempt completes user\\_data Passed to the userdata param of on\\_connection\\_complete
 """
 struct aws_mqtt_connection_options
     host_name::aws_byte_cursor