DocC extensions (#315)

* Add extensions.

* Cleanup
This commit is contained in:
Max Goedjen 2022-01-02 15:19:36 -08:00 committed by GitHub
parent b0322b4c1f
commit 3df7ce6256
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 36 additions and 8 deletions

View File

@ -18,8 +18,8 @@ public struct SemVer {
versionNumbers = split
}
/// Initializes a SemVer from an ``OperatingSystemVersion`` representation.
/// - Parameter version: An ``OperatingSystemVersion`` representation of the SemVer.
/// Initializes a SemVer from an `OperatingSystemVersion` representation.
/// - Parameter version: An `OperatingSystemVersion` representation of the SemVer.
public init(_ version: OperatingSystemVersion) {
versionNumbers = [version.majorVersion, version.minorVersion, version.patchVersion]
}

View File

@ -6,17 +6,17 @@ public protocol SigningWitness {
/// A ridiculously named method that notifies the callee that a signing operation is about to be performed using a secret. The callee may `throw` an `Error` to prevent access from occurring.
/// - Parameters:
/// - secret: The ``SecretKit.Secret`` that will be used to sign the request.
/// - store: The ``SecretKit.Store`` being asked to sign the request..
/// - provenance: A ``SecretKit.SigningRequestProvenance`` object describing the origin of the request.
/// - secret: The `Secret` that will be used to sign the request.
/// - store: The `Store` being asked to sign the request..
/// - provenance: A `SigningRequestProvenance` object describing the origin of the request.
/// - Note: This method being called does not imply that the requst has been authorized. If a secret requires authentication, authentication will still need to be performed by the user before the request will be performed. If the user declines or fails to authenticate, the request will fail.
func speakNowOrForeverHoldYourPeace(forAccessTo secret: AnySecret, from store: AnySecretStore, by provenance: SigningRequestProvenance) throws
/// Notifies the callee that a signing operation has been performed for a given secret.
/// - Parameters:
/// - secret: The ``SecretKit.Secret`` that will was used to sign the request.
/// - store: The ``SecretKit.Store`` that signed the request..
/// - provenance: A ``SecretKit.SigningRequestProvenance`` object describing the origin of the request.
/// - secret: The `Secret` that will was used to sign the request.
/// - store: The `Store` that signed the request..
/// - provenance: A `SigningRequestProvenance` object describing the origin of the request.
/// - requiredAuthentication: A boolean describing whether or not authentication was required for the request.
func witness(accessTo secret: AnySecret, from store: AnySecretStore, by provenance: SigningRequestProvenance, requiredAuthentication: Bool) throws

View File

@ -0,0 +1,14 @@
# ``SecureEnclaveSecretKit/SecureEnclave``
## Topics
### Implementations
- ``Secret``
- ``Store``
### Errors
- ``KeychainError``
- ``SigningError``
- ``SecurityError``

View File

@ -0,0 +1,14 @@
# ``SmartCardSecretKit/SmartCard``
## Topics
### Implementations
- ``Secret``
- ``Store``
### Errors
- ``KeychainError``
- ``SigningError``
- ``SecurityError``