Clean up the docs references as well

Author: Lukasa

Sources/X509/Docs.docc/Creating Certificates.md

@@ -84,9 +84,9 @@ certificate. For self-signed certificates, the issuer and the subject are identi
 The bulk of the semantic information in a certificate is contained in its extensions. For our case, we care about only a small
 few.
 
-We need ``Certificate/Extensions-swift.struct/BasicConstraints-swift.enum`` to be present, and set to
-`isCertificateAuthority`. We also need ``Certificate/Extensions-swift.struct/KeyUsage-swift.struct`` with the appropriate bits
-set. Finally, we want to set ``Certificate/Extensions-swift.struct/SubjectAlternativeNames-swift.struct`` to include the domain
+We need ``BasicConstraints`` to be present, and set to
+`isCertificateAuthority`. We also need ``KeyUsage`` with the appropriate bits
+set. Finally, we want to set ``SubjectAlternativeNames`` to include the domain
 name we're going to be self-signing for, which in this case we'll set to `localhost`.
 
 We can use the helpful builder syntax for this:

Sources/X509/Docs.docc/Examining Certificates.md

@@ -99,17 +99,17 @@ bytes in an extension, as well as wrap themselves back into the opaque ``Certifi
 
 Out of the box, ``X509`` ships support for the following extension types:
 
-- ``Certificate/Extensions-swift.struct/AuthorityInformationAccess-swift.struct``
-- ``Certificate/Extensions-swift.struct/AuthorityKeyIdentifier-swift.struct``
-- ``Certificate/Extensions-swift.struct/BasicConstraints-swift.enum``
-- ``Certificate/Extensions-swift.struct/ExtendedKeyUsage-swift.struct``
-- ``Certificate/Extensions-swift.struct/KeyUsage-swift.struct``
-- ``Certificate/Extensions-swift.struct/NameConstraints-swift.struct``
-- ``Certificate/Extensions-swift.struct/SubjectAlternativeNames-swift.struct``
-- ``Certificate/Extensions-swift.struct/SubjectKeyIdentifier-swift.struct``
+- ``AuthorityInformationAccess``
+- ``AuthorityKeyIdentifier``
+- ``BasicConstraints``
+- ``ExtendedKeyUsage``
+- ``KeyUsage``
+- ``NameConstraints``
+- ``SubjectAlternativeNames``
+- ``SubjectKeyIdentifier``
 
 To decode an extension usually requires examining its ``Certificate/Extension/oid`` field. For example, to search
-for the ``Certificate/Extensions-swift.struct/SubjectAlternativeNames-swift.struct``, the typical code would be:
+for the ``SubjectAlternativeNames``, the typical code would be:
 
 ```swift
 let opaqueSANExtension = certificate.extensions.first(where: { $0.oid == .X509ExtensionID.subjectAlternativeName })
@@ -130,14 +130,14 @@ if let opaqueSanExtension = certificate.extensions[oid: .X509ExtensionID.subject
 This pattern is itself still somewhat repetitive, so ``Certificate/Extensions-swift.struct`` offers a number of helper properties
 that can be used to get a specific typed extension:
 
-- ``Certificate/Extensions-swift.struct/authorityInformationAccess-swift.property``
-- ``Certificate/Extensions-swift.struct/authorityKeyIdentifier-swift.property``
-- ``Certificate/Extensions-swift.struct/basicConstraints-swift.property``
-- ``Certificate/Extensions-swift.struct/extendedKeyUsage-swift.property``
-- ``Certificate/Extensions-swift.struct/keyUsage-swift.property``
-- ``Certificate/Extensions-swift.struct/nameConstraints-swift.property``
-- ``Certificate/Extensions-swift.struct/subjectAlternativeNames-swift.property``
-- ``Certificate/Extensions-swift.struct/subjectKeyIdentifier-swift.property``
+- ``Certificate/Extensions-swift.struct/authorityInformationAccess``
+- ``Certificate/Extensions-swift.struct/authorityKeyIdentifier``
+- ``Certificate/Extensions-swift.struct/basicConstraints``
+- ``Certificate/Extensions-swift.struct/extendedKeyUsage``
+- ``Certificate/Extensions-swift.struct/keyUsage``
+- ``Certificate/Extensions-swift.struct/nameConstraints``
+- ``Certificate/Extensions-swift.struct/subjectAlternativeNames``
+- ``Certificate/Extensions-swift.struct/subjectKeyIdentifier``
 
 This lets us reduce the above code to a single line:
 

Sources/X509/Docs.docc/index.md

@@ -47,14 +47,14 @@ certificate authorities, authenticating peers, and more.
 
 ### Supported Extension Types
 
-- ``Certificate/Extensions-swift.struct/AuthorityInformationAccess-swift.struct``
-- ``Certificate/Extensions-swift.struct/AuthorityKeyIdentifier-swift.struct``
-- ``Certificate/Extensions-swift.struct/BasicConstraints-swift.enum``
-- ``Certificate/Extensions-swift.struct/ExtendedKeyUsage-swift.struct``
-- ``Certificate/Extensions-swift.struct/KeyUsage-swift.struct``
-- ``Certificate/Extensions-swift.struct/NameConstraints-swift.struct``
-- ``Certificate/Extensions-swift.struct/SubjectAlternativeNames-swift.struct``
-- ``Certificate/Extensions-swift.struct/SubjectKeyIdentifier-swift.struct``
+- ``AuthorityInformationAccess``
+- ``AuthorityKeyIdentifier``
+- ``BasicConstraints``
+- ``ExtendedKeyUsage``
+- ``KeyUsage``
+- ``NameConstraints``
+- ``SubjectAlternativeNames``
+- ``SubjectKeyIdentifier``
 - ``Critical``
 
 ### Names

Sources/X509/Extension Types/AuthorityInformationAccess.swift

@@ -16,14 +16,14 @@ import SwiftASN1
 
 /// Provides details on how to access information about the certificate issuer.
 ///
-/// This extension behaves as a collection of ``Certificate/Extensions-swift.struct/AuthorityInformationAccess-swift.struct/AccessDescription`` objects.
+/// This extension behaves as a collection of ``AuthorityInformationAccess/AccessDescription`` objects.
 ///
 /// In practice this most commonly contains OCSP servers and links to the issuing CA certificate.
 public struct AuthorityInformationAccess {
     @usableFromInline
     var descriptions: [AccessDescription]
 
-    /// Create a new ``Certificate/Extensions-swift.struct/AuthorityInformationAccess-swift.struct/`` object
+    /// Create a new ``AuthorityInformationAccess/`` object
     /// containing specific access descriptions.
     ///
     /// - Parameter descriptions: The descriptions to include in the AIA extension.
@@ -32,7 +32,7 @@ public struct AuthorityInformationAccess {
         self.descriptions = Array(descriptions)
     }
 
-    /// Create a new ``Certificate/Extensions-swift.struct/AuthorityInformationAccess-swift.struct`` object
+    /// Create a new ``AuthorityInformationAccess`` object
     /// by unwrapping a ``Certificate/Extension``.
     ///
     /// - Parameter ext: The ``Certificate/Extension`` to unwrap
@@ -93,7 +93,7 @@ extension AuthorityInformationAccess {
         /// The location where the information may be found.
         public var location: GeneralName
 
-        /// Construct a new ``Certificate/Extensions-swift.struct/AuthorityInformationAccess-swift.struct/AccessDescription`` from constituent parts.
+        /// Construct a new ``AuthorityInformationAccess/AccessDescription`` from constituent parts.
         @inlinable
         public init(method: AccessMethod, location: GeneralName) {
             self.method = method
@@ -120,7 +120,7 @@ extension AuthorityInformationAccess.AccessDescription: CustomStringConvertible
 
 extension AuthorityInformationAccess.AccessDescription {
     /// The format and meaning of the information included in a single
-    /// ``Certificate/Extensions-swift.struct/AuthorityInformationAccess-swift.struct/AccessDescription``
+    /// ``AuthorityInformationAccess/AccessDescription``
     /// object.
     public struct AccessMethod {
         @usableFromInline

Sources/X509/Extension Types/AuthorityKeyIdentifier.swift

@@ -29,7 +29,7 @@ public struct AuthorityKeyIdentifier {
     /// The serial number of the issuing cert.
     public var authorityCertSerialNumber: Certificate.SerialNumber?
 
-    /// Create a new ``Certificate/Extensions-swift.struct/AuthorityKeyIdentifier-swift.struct`` extension value.
+    /// Create a new ``AuthorityKeyIdentifier`` extension value.
     ///
     /// - Parameters:
     ///   - keyIdentifier: An opaque sequence of bytes uniquely derived from the public key of the issuing CA.
@@ -42,7 +42,7 @@ public struct AuthorityKeyIdentifier {
         self.authorityCertSerialNumber = authorityCertSerialNumber
     }
 
-    /// Create a new ``Certificate/Extensions-swift.struct/AuthorityKeyIdentifier-swift.struct`` object
+    /// Create a new ``AuthorityKeyIdentifier`` object
     /// by unwrapping a ``Certificate/Extension``.
     ///
     /// - Parameter ext: The ``Certificate/Extension`` to unwrap

Sources/X509/Extension Types/BasicConstraints.swift

@@ -29,7 +29,7 @@ public enum BasicConstraints {
     /// certificate.
     case notCertificateAuthority
 
-    /// Create a new ``Certificate/Extensions-swift.struct/BasicConstraints-swift.enum`` object
+    /// Create a new ``BasicConstraints`` object
     /// by unwrapping a ``Certificate/Extension``.
     ///
     /// - Parameter ext: The ``Certificate/Extension`` to unwrap

Sources/X509/Extension Types/ExtendedKeyUsage.swift

@@ -16,12 +16,12 @@ import SwiftASN1
 
 /// Indicates one or more purposes for which the certified public key
 /// may be used, in addition to or instead of the the purposes indicated
-/// in the ``KeyUsage-swift.struct`` extension.
+/// in the ``KeyUsage`` extension.
 public struct ExtendedKeyUsage {
     @usableFromInline
     var usages: [Usage]
 
-    /// Construct an ``Certificate/Extensions-swift.struct/ExtendedKeyUsage-swift.struct`` extension containing the
+    /// Construct an ``ExtendedKeyUsage`` extension containing the
     /// given usages.
     ///
     /// - Parameter usages: The purposes for which the certificate may be used.
@@ -30,7 +30,7 @@ public struct ExtendedKeyUsage {
         self.usages = Array(usages)
     }
 
-    /// Create a new ``Certificate/Extensions-swift.struct/ExtendedKeyUsage-swift.struct`` object
+    /// Create a new ``ExtendedKeyUsage`` object
     /// by unwrapping a ``Certificate/Extension``.
     ///
     /// - Parameter ext: The ``Certificate/Extension`` to unwrap
@@ -82,7 +82,7 @@ extension ExtendedKeyUsage: RandomAccessCollection {
 
 extension ExtendedKeyUsage {
     /// An acceptable usage for a certificate as attested in an
-    /// ``Certificate/Extensions-swift.struct/ExtendedKeyUsage-swift.struct``
+    /// ``ExtendedKeyUsage``
     /// extension.
     public struct Usage {
         @usableFromInline
@@ -106,7 +106,7 @@ extension ExtendedKeyUsage {
             self.backing = backing
         }
 
-        /// Constructs a ``Certificate/Extensions-swift.struct/ExtendedKeyUsage-swift.struct/Usage`` from an opaque oid.
+        /// Constructs a ``ExtendedKeyUsage/Usage`` from an opaque oid.
         ///
         /// - Parameter oid: The OID of the usage.
         @inlinable
@@ -242,7 +242,7 @@ extension ASN1ObjectIdentifier {
     }
 
     /// An acceptable usage for a certificate as attested in an
-    /// ``Certificate/Extensions-swift.struct/ExtendedKeyUsage-swift.struct``
+    /// ``ExtendedKeyUsage``
     /// extension.
     public enum ExtendedKeyUsage {
         /// The public key may be used for any purpose.

Sources/X509/Extension Types/ExtensionIdentifiers.swift

@@ -18,35 +18,35 @@ extension ASN1ObjectIdentifier {
     /// OIDs that identify known X509 extensions.
     public enum X509ExtensionID {
         /// Identifies the authority key identifier extension, corresponding to
-        /// ``Certificate/Extensions-swift.struct/AuthorityKeyIdentifier-swift.struct``.
+        /// ``AuthorityKeyIdentifier``.
         public static let authorityKeyIdentifier: ASN1ObjectIdentifier = [2, 5, 29, 35]
 
         /// Identifies the subject key identifier extension, corresponding to
-        /// ``Certificate/Extensions-swift.struct/SubjectKeyIdentifier-swift.struct``.
+        /// ``SubjectKeyIdentifier``.
         public static let subjectKeyIdentifier: ASN1ObjectIdentifier = [2, 5, 29, 14]
 
         /// Identifies the key usgae extension, corresponding to
-        /// ``Certificate/Extensions-swift.struct/KeyUsage-swift.struct``.
+        /// ``KeyUsage``.
         public static let keyUsage: ASN1ObjectIdentifier = [2, 5, 29, 15]
 
         /// Identifies the subject alternative name extension, corresponding to
-        /// ``Certificate/Extensions-swift.struct/SubjectAlternativeNames-swift.struct``.
+        /// ``SubjectAlternativeNames``.
         public static let subjectAlternativeName: ASN1ObjectIdentifier = [2, 5, 29, 17]
 
         /// Identifies the basic constraints extension, corresponding to
-        /// ``Certificate/Extensions-swift.struct/BasicConstraints-swift.enum``.
+        /// ``BasicConstraints``.
         public static let basicConstraints: ASN1ObjectIdentifier = [2, 5, 29, 19]
 
         /// Identifies the name constraints extension, corresponding to
-        /// ``Certificate/Extensions-swift.struct/NameConstraints-swift.struct``.
+        /// ``NameConstraints``.
         public static let nameConstraints: ASN1ObjectIdentifier = [2, 5, 29, 30]
 
         /// Identifies the extended key usage extension, corresponding to
-        /// ``Certificate/Extensions-swift.struct/ExtendedKeyUsage-swift.struct``.
+        /// ``ExtendedKeyUsage``.
         public static let extendedKeyUsage: ASN1ObjectIdentifier = [2, 5, 29, 37]
 
         /// Identifies the authority information access extension, corresponding to
-        /// ``Certificate/Extensions-swift.struct/AuthorityInformationAccess-swift.struct``.
+        /// ``AuthorityInformationAccess``.
         public static let authorityInformationAccess: ASN1ObjectIdentifier = [1, 3, 6, 1, 5, 5, 7, 1, 1]
     }
 }

Sources/X509/Extension Types/KeyUsage.swift

@@ -25,13 +25,13 @@ public struct KeyUsage {
     @usableFromInline
     internal var rawValue: UInt16
 
-    /// Construct a ``Certificate/Extensions-swift.struct/KeyUsage-swift.struct`` extension with no usages set.
+    /// Construct a ``KeyUsage`` extension with no usages set.
     @inlinable
     public init() {
         self.rawValue = 0
     }
 
-    /// Construct a ``Certificate/Extensions-swift.struct/KeyUsage-swift.struct`` extension with some usages set.
+    /// Construct a ``KeyUsage`` extension with some usages set.
     ///
     /// - Parameters:
     ///   - digitalSignature: This is true when the subject public key is used for verifying digital signatures,
@@ -80,7 +80,7 @@ public struct KeyUsage {
         self.decipherOnly = decipherOnly
     }
 
-    /// Create a new ``Certificate/Extensions-swift.struct/KeyUsage-swift.struct`` object
+    /// Create a new ``KeyUsage`` object
     /// by unwrapping a ``Certificate/Extension``.
     ///
     /// - Parameter ext: The ``Certificate/Extension`` to unwrap

Sources/X509/Extension Types/NameConstraints.swift

@@ -17,7 +17,7 @@ import SwiftASN1
 /// Constraints the namespace within which all subject names issued by a given CA must reside.
 ///
 /// These constraints apply both to the ``Certificate/subject`` and also to any
-/// ``SubjectAlternativeNames-swift.struct`` that may be present. Restrictions are applied to
+/// ``SubjectAlternativeNames`` that may be present. Restrictions are applied to
 /// specific name _forms_, and when the form is not present then the restriction does not apply.
 ///
 /// Restrictions are defined in terms of both permitted and forbidden subtrees. The forbidden trees
@@ -263,7 +263,7 @@ public struct NameConstraints {
         self.excludedSubtrees = excludedSubtrees
     }
 
-    /// Create a new ``Certificate/Extensions-swift.struct/NameConstraints-swift.struct`` object
+    /// Create a new ``NameConstraints`` object
     /// by unwrapping a ``Certificate/Extension``.
     ///
     /// - Parameter ext: The ``Certificate/Extension`` to unwrap

Sources/X509/Extension Types/SubjectAlternativeName.swift

@@ -38,7 +38,7 @@ public struct SubjectAlternativeNames {
         self.names = []
     }
 
-    /// Create a new ``Certificate/Extensions-swift.struct/SubjectAlternativeNames-swift.struct`` object
+    /// Create a new ``SubjectAlternativeNames`` object
     /// by unwrapping a ``Certificate/Extension``.
     ///
     /// - Parameter ext: The ``Certificate/Extension`` to unwrap

Sources/X509/Extension Types/SubjectKeyIdentifier.swift

@@ -17,7 +17,7 @@ import SwiftASN1
 /// Provides a means of identifying a certificate that contains a particular public key.
 ///
 /// This extension contains a value derived from the public key of the certificate in which it appears.
-/// That value can be used to build the ``AuthorityKeyIdentifier-swift.struct/keyIdentifier`` field in
+/// That value can be used to build the ``AuthorityKeyIdentifier/keyIdentifier`` field in
 /// any certificate issued by this certificate. This makes it possible to identify a certificate
 /// possessing the key that issued another certificate.
 public struct SubjectKeyIdentifier {
@@ -31,7 +31,7 @@ public struct SubjectKeyIdentifier {
         self.keyIdentifier = keyIdentifier
     }
 
-    /// Create a new ``Certificate/Extensions-swift.struct/SubjectKeyIdentifier-swift.struct`` object
+    /// Create a new ``SubjectKeyIdentifier`` object
     /// by unwrapping a ``Certificate/Extension``.
     ///
     /// - Parameter ext: The ``Certificate/Extension`` to unwrap

Sources/X509/Extension.swift

@@ -24,14 +24,14 @@ extension Certificate {
     /// it does not understand. A number of extensions have built-in support, and can be decoded directly from an ``Extension``
     /// value. These are:
     ///
-    /// - ``Certificate/Extensions-swift.struct/AuthorityInformationAccess-swift.struct``
-    /// - ``Certificate/Extensions-swift.struct/AuthorityKeyIdentifier-swift.struct``
-    /// - ``Certificate/Extensions-swift.struct/BasicConstraints-swift.enum``
-    /// - ``Certificate/Extensions-swift.struct/ExtendedKeyUsage-swift.struct``
-    /// - ``Certificate/Extensions-swift.struct/KeyUsage-swift.struct``
-    /// - ``Certificate/Extensions-swift.struct/NameConstraints-swift.struct``
-    /// - ``Certificate/Extensions-swift.struct/SubjectAlternativeNames-swift.struct``
-    /// - ``Certificate/Extensions-swift.struct/SubjectKeyIdentifier-swift.struct``
+    /// - ``AuthorityInformationAccess``
+    /// - ``AuthorityKeyIdentifier``
+    /// - ``BasicConstraints``
+    /// - ``ExtendedKeyUsage``
+    /// - ``KeyUsage``
+    /// - ``NameConstraints``
+    /// - ``SubjectAlternativeNames``
+    /// - ``SubjectKeyIdentifier``
     ///
     /// Users can write their own types by using a similar approach to these types, when it is necessary to add support for
     /// different X.509 extension.