docs: Fix dead links

.github/workflows/ci_docs.yml

@@ -0,0 +1,25 @@
+name: Verify documentation integrity
+'on':
+  workflow_call: null
+jobs:
+  cov:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build documentation - treat doc warnings as problems
+        run: RUSTDOCFLAGS="-D warnings" cargo doc
+
+      - uses: cargo-bins/[email protected]
+      - name: Install cargo-deadlinks binary
+        run: cargo binstall [email protected] --no-confirm
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+
+      # `no-build` is passed, as we already built the docs
+      - name: Check for dead links in docs
+        run: cargo deadlinks --no-build
+
+      - name: Check for dead https(s) links in docs
+        run: cargo deadlinks --check-http --no-build

.github/workflows/main.yml

@@ -51,6 +51,9 @@ jobs:
   code-coverage:
     uses: ./.github/workflows/ci_code_coverage.yml
 
+  docs:
+    uses: ./.github/workflows/ci_docs.yml
+
   verify-clean-address-space:
     uses: ./.github/workflows/ci_verify_clean_address_space.yml
 

lib/src/client/builder.rs

@@ -24,8 +24,6 @@ impl ClientBuilder {
 
     /// Yields a [`Client`] from the values set by the builder. If the builder is not in a valid state
     /// it will return `None`.
-    ///
-    /// [`Client`]: client/struct.Client.html
     pub fn client(self) -> Option<Client> {
         if self.is_valid() {
             Some(Client::new(self.config))
@@ -35,8 +33,6 @@ impl ClientBuilder {
     }
 
     /// Yields a [`ClientConfig`] from the values set by the builder.
-    ///
-    /// [`ClientConfig`]: ../config/struct.ClientConfig.html
     pub fn config(self) -> ClientConfig {
         self.config
     }

lib/src/client/mod.rs

@@ -104,11 +104,6 @@
 //!    }
 //!}
 //! ```
-//!
-//! [`Client`]: ./client/struct.Client.html
-//! [`ClientConfig`]: ./config/struct.ClientConfig.html
-//! [`ClientBuilder`]: ./client_builder/struct.ClientBuilder.html
-//! [`Session`]: ./session/struct.Session.html
 
 mod builder;
 mod config;

lib/src/client/session/client.rs

@@ -197,7 +197,7 @@ impl Client {
             .unwrap())
     }
 
-    /// Connects to an a server directly using provided [`SessionInfo`].
+    /// Connects to a server directly using provided SessionInfo.
     ///
     /// This function returns both a reference to the session, and a `SessionEventLoop`. You must run and
     /// poll the event loop in order to actually establish a connection.
@@ -237,7 +237,7 @@ impl Client {
         }
     }
 
-    /// Creates a new [`AsyncSession`] using the default endpoint specified in the config. If
+    /// Creates a new [`Session`] using the default endpoint specified in the config. If
     /// there is no default, or the endpoint does not exist, this function will return an error
     ///
     /// This function returns both a reference to the session, and a `SessionEventLoop`. You must run and
@@ -264,7 +264,7 @@ impl Client {
         self.new_session_from_info(session_info)
     }
 
-    /// Creates a new [`AsyncSession`] using the named endpoint id. If there is no
+    /// Creates a new [`Session`] using the named endpoint id. If there is no
     /// endpoint of that id in the config, this function will return an error
     ///
     /// This function returns both a reference to the session, and a `SessionEventLoop`. You must run and

lib/src/client/session/services/attributes.rs

@@ -253,7 +253,7 @@ impl Session {
     ///
     /// # Returns
     ///
-    /// * `Ok(Vec<ClientHistoryUpdateResult>)` - A list of [`ClientHistoryUpdateResult`] results corresponding to history update operation.
+    /// * `Ok(Vec<HistoryUpdateResult>)` - A list of [`HistoryUpdateResult`] results corresponding to history update operation.
     /// * `Err(StatusCode)` - Request failed, [Status code](StatusCode) is the reason for failure.
     ///
     pub async fn history_update(

lib/src/crypto/certificate_store.rs

@@ -410,7 +410,7 @@ impl CertificateStore {
     }
 
     /// Returns a certificate file name from the cert's issuer and thumbprint fields.
-    /// File name is either "prefix - [thumbprint].der" or "thumbprint.der" depending on
+    /// File name is either "prefix - \[thumbprint\].der" or "thumbprint.der" depending on
     /// the cert's common name being empty or not
     pub fn cert_file_name(cert: &X509) -> String {
         let prefix = if let Ok(common_name) = cert.common_name() {

lib/src/crypto/hash.rs

@@ -14,8 +14,8 @@ use super::{SHA1_SIZE, SHA256_SIZE};
 
 /// Pseudo random `P_SHA` implementation for creating pseudo random range of bytes from an input
 ///
-/// https://www.ietf.org/rfc/rfc4346.txt
-/// https://tools.ietf.org/html/rfc5246
+/// <https://www.ietf.org/rfc/rfc4346.txt>
+/// <https://tools.ietf.org/html/rfc5246>
 ///
 /// P_SHA1(secret, seed) = HMAC_SHA1(secret, A(1) + seed) +
 ///                        HMAC_SHA1(secret, A(2) + seed) +

lib/src/crypto/pkey.rs

@@ -370,7 +370,7 @@ impl PublicKey {
 
 /// This module contains a bunch of nasty stuff to implement OAEP-SHA256 since there are no helpers in OpenSSL to do it
 ///
-/// https://stackoverflow.com/questions/17784022/how-to-encrypt-data-using-rsa-with-sha-256-as-hash-function-and-mgf1-as-mask-ge
+/// <https://stackoverflow.com/questions/17784022/how-to-encrypt-data-using-rsa-with-sha-256-as-hash-function-and-mgf1-as-mask-ge>
 mod oaep_sha256 {
     use foreign_types::ForeignType;
     use libc::*;

lib/src/crypto/security_policy.rs

@@ -108,11 +108,11 @@ mod basic_256_sha_256 {
 
 /// Basic128Rsa15 security policy (deprecated in OPC UA 1.04)
 ///
-///   AsymmetricSignatureAlgorithm – RsaSha1 – (http://www.w3.org/2000/09/xmldsig#rsa-sha1).
-///   AsymmetricEncryptionAlgorithm – Rsa15 – (http://www.w3.org/2001/04/xmlenc#rsa-1_5).
-///   SymmetricSignatureAlgorithm – HmacSha1 – (http://www.w3.org/2000/09/xmldsig#hmac-sha1).
-///   SymmetricEncryptionAlgorithm – Aes128 – (http://www.w3.org/2001/04/xmlenc#aes128-cbc).
-///   KeyDerivationAlgorithm – PSha1 – (http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512/dk/p_sha1).
+///   AsymmetricSignatureAlgorithm – RsaSha1 – (<http://www.w3.org/2000/09/xmldsig#rsa-sha1>).
+///   AsymmetricEncryptionAlgorithm – Rsa15 – (<http://www.w3.org/2001/04/xmlenc#rsa-1_5>).
+///   SymmetricSignatureAlgorithm – HmacSha1 – (<http://www.w3.org/2000/09/xmldsig#hmac-sha1>).
+///   SymmetricEncryptionAlgorithm – Aes128 – (<http://www.w3.org/2001/04/xmlenc#aes128-cbc>).
+///   KeyDerivationAlgorithm – PSha1 – (<http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512/dk/p_sha1>).
 ///
 /// # Limits
 ///
@@ -135,11 +135,11 @@ mod basic_128_rsa_15 {
 
 /// Basic256 security policy (deprecated in OPC UA 1.04)
 ///
-///   AsymmetricSignatureAlgorithm – RsaSha1 – (http://www.w3.org/2000/09/xmldsig#rsa-sha1).
-///   AsymmetricEncryptionAlgorithm – RsaOaep – (http://www.w3.org/2001/04/xmlenc#rsa-oaep).
-///   SymmetricSignatureAlgorithm – HmacSha1 – (http://www.w3.org/2000/09/xmldsig#hmac-sha1).
-///   SymmetricEncryptionAlgorithm – Aes256 – (http://www.w3.org/2001/04/xmlenc#aes256-cbc).
-///   KeyDerivationAlgorithm – PSha1 – (http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512/dk/p_sha1).
+///   AsymmetricSignatureAlgorithm – RsaSha1 – (<http://www.w3.org/2000/09/xmldsig#rsa-sha1>).
+///   AsymmetricEncryptionAlgorithm – RsaOaep – (<http://www.w3.org/2001/04/xmlenc#rsa-oaep>).
+///   SymmetricSignatureAlgorithm – HmacSha1 – (<http://www.w3.org/2000/09/xmldsig#hmac-sha1>).
+///   SymmetricEncryptionAlgorithm – Aes256 – (<http://www.w3.org/2001/04/xmlenc#aes256-cbc>).
+///   KeyDerivationAlgorithm – PSha1 – (<http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512/dk/p_sha1>).
 ///
 /// # Limits
 ///

lib/src/server/server.rs

@@ -58,7 +58,7 @@ pub type Connections = Vec<Arc<RwLock<TcpTransport>>>;
 /// [`run_server`]: #method.run_server
 /// [`ServerConfig`]: ../config/struct.ServerConfig.html
 /// [`AddressSpace`]: ../address_space/address_space/struct.AddressSpace.html
-/// [`CertificateStore`]: ../../opcua_core/crypto/certificate_store/struct.CertificateStore.html
+/// [`CertificateStore`]: ../../crypto/certificate_store/struct.CertificateStore.html
 ///
 pub struct Server {
     /// List of pending polling actions to add to the server once run is called

lib/src/types/array.rs

@@ -13,8 +13,8 @@ pub struct Array {
 
     /// Multi dimension array which can contain any scalar type, all the same type. Nested
     /// arrays are rejected. Higher rank dimensions are serialized first. For example an array
-    /// with dimensions [2,2,2] is written in this order - [0,0,0], [0,0,1], [0,1,0], [0,1,1],
-    /// [1,0,0], [1,0,1], [1,1,0], [1,1,1].
+    /// with dimensions \[2,2,2\] is written in this order - \[0,0,0\], \[0,0,1\], \[0,1,0\],
+    /// \[0,1,1\], \[1,0,0\], \[1,0,1\], \[1,1,0\], \[1,1,1\].
     pub dimensions: Option<Vec<u32>>,
 }