Skip to content

Commit 7c0b45d

Browse files
author
Neno Stefanov
committed
Update reference links
1 parent f50bd77 commit 7c0b45d

File tree

7 files changed

+19
-17
lines changed

7 files changed

+19
-17
lines changed

MIRACLTrust/MIRACLTrust-Sources/Configuration.swift

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ import Foundation
4242
loggingLevel = .none
4343
}
4444

45-
/// Builds [Configuration](x-source-tag://Configuration) objects.
45+
/// Builds ``Configuration`` objects.
4646
@objc(ConfigurationBuilder) public class Builder: NSObject {
4747
private var configurationToBuild = Configuration()
4848

49-
/// Initializing [Configuration.Builder](x-source-tag://Configuration.Builder) object.
49+
/// Initializing ``Configuration/Builder`` object.
5050
/// - Parameters:
5151
/// - projectId: `Project ID` setting for the MIRACL Platform.
5252
/// - deviceName: identifier that can help find the device on the MIRACL Trust Portal.
@@ -69,8 +69,8 @@ import Foundation
6969
}
7070
}
7171

72-
/// Set custom [UserStorage](x-source-tag://protocols-UserStorage) implementation.
73-
/// - Parameter userStorage: custom [UserStorage](x-source-tag://protocols-UserStorage)) implementation.
72+
/// Set custom ``UserStorage`` implementation.
73+
/// - Parameter userStorage: custom ``UserStorage`` implementation.
7474
/// - Returns: Configuration.Builder object.
7575
@discardableResult public func userStorage(
7676
userStorage: UserStorage
@@ -89,8 +89,8 @@ import Foundation
8989
return self
9090
}
9191

92-
/// Set custom [Logger](x-source-tag://protocols-Logger) writer implementation.
93-
/// - Parameter logger: custom [Logger](x-source-tag://protocols-Logger) implementation.
92+
/// Set custom ``Logger`` writer implementation.
93+
/// - Parameter logger: custom ``Logger`` implementation.
9494
/// - Returns: Configuration.Builder object.
9595
@objc(loggerWith:) @discardableResult public func logger(
9696
logger: Logger
@@ -99,9 +99,9 @@ import Foundation
9999
return self
100100
}
101101

102-
/// Sets custom [LoggingLevel](x-source-tag://enums-LoggingLevel) value. By default it is `none`.
102+
/// Sets custom ``LoggingLevel`` value. By default it is ``LoggingLevel/none``.
103103
/// This level can be set only for default logger, otherwise will be ignored.
104-
/// - Parameter level: custom [LoggingLevel](x-source-tag://enums-LoggingLevel)
104+
/// - Parameter level: custom ``LoggingLevel``
105105
/// - Returns: Configuration.Builder object.
106106
@objc(loggingLevelWith:) @discardableResult public func loggingLevel(
107107
level: LoggingLevel
@@ -143,9 +143,9 @@ import Foundation
143143
return self
144144
}
145145

146-
/// Returns [Configuration](x-source-tag://Configuration) object.
147-
/// - Throws: [ConfigurationError](x-source-tag://enums-ConfigurationError).
148-
/// - Returns: [Configuration](x-source-tag://Configuration) object.
146+
/// Returns ``Configuration`` object.
147+
/// - Throws: ``ConfigurationError``.
148+
/// - Returns: ``Configuration`` object.
149149
@objc public func build() throws -> Configuration {
150150
if configurationToBuild.projectId.isEmpty {
151151
throw ConfigurationError.configurationEmptyProjectId

MIRACLTrust/MIRACLTrust-Sources/MIRACLTrust.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ import Foundation
6262
}
6363
}
6464

65-
/// Configure SDK with values issued by MIRACL and stored in the [Configuration](x-source-tag://Configuration) object.
65+
/// Configure SDK with values issued by MIRACL and stored in the ``Configuration`` object.
6666
/// It is recommended to be called right after the application is launched.
6767
/// - Parameter configuration:object storing configurations of the SDK.
6868
@objc public class func configure(with configuration: Configuration) throws {

MIRACLTrust/MIRACLTrust-Sources/Signing/SigningResult.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import Foundation
22

3-
/// Result returned by ``MIRACLTrust/MIRACLTrust/sign(message:user:signingSessionDetails:didRequestSigningPinHandler:completionHandler:)`` method.
3+
/// Result returned by ``MIRACLTrust/MIRACLTrust/sign(message:user:didRequestSigningPinHandler:completionHandler:)`` method.
44
@objcMembers
55
public final class SigningResult: NSObject, Sendable {
66
/// Cryptographic representation of the signature

MIRACLTrust/MIRACLTrust-Sources/Verification/ActivationTokenError.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ public enum ActivationTokenError: Error {
88
/// Empty verification code in the universal link.
99
case emptyVerificationCode
1010

11-
/// Invalid or expired activation code. There may be [ActivationTokenErrorResponse](x-source-tag://classes-ActivationTokenErrorResponse) in the error.
11+
/// Invalid or expired activation code. There may be ``ActivationTokenErrorResponse`` in the error.
1212
case unsuccessfulVerification(activationTokenErrorResponse: ActivationTokenErrorResponse?)
1313

1414
/// The request for fetching the activation token failed.

MIRACLTrust/MIRACLTrust-Sources/Verification/ActivationTokenErrorResponse.swift

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import Foundation
22

3-
/// The response returned from [getActivationToken](x-source-tag://miracltrust-_FUNC_getactivationtokenverificationurlcompletionhandler).
3+
/// The response returned from ``MIRACLTrust/MIRACLTrust/getActivationToken(verificationURL:completionHandler:)``
4+
/// and ``MIRACLTrust/MIRACLTrust/getActivationToken(userId:code:completionHandler:)``
45
/// when there is an error in the request.
56
/// - Tag: classes-ActivationTokenErrorResponse
67
@objcMembers

MIRACLTrust/MIRACLTrust-Sources/Verification/ActivationTokenResponse.swift

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import Foundation
22

3-
/// The response returned from [getActivationToken](x-source-tag://miracltrust-_FUNC_getactivationtokenverificationurlcompletionhandler).
3+
/// The response returned from ``MIRACLTrust/MIRACLTrust/getActivationToken(verificationURL:completionHandler:)``
4+
/// and ``MIRACLTrust/MIRACLTrust/getActivationToken(userId:code:completionHandler:)``.
45
@objcMembers
56
@objc public final class ActivationTokenResponse: NSObject, Sendable {
67
/// The activation token returned after successful user verification.

MIRACLTrust/MIRACLTrust-Sources/Verification/VerificationResponse.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import Foundation
22

3-
/// The response returned from [sendVerificationEmail](x-source-tag://miracltrust-_FUNC_sendverificationemailuseridauthenticationsessiondetailscompletionhandler).
3+
/// The response returned from ``MIRACLTrust/MIRACLTrust/sendVerificationEmail(userId:authenticationSessionDetails:completionHandler:)``.
44
@objcMembers
55
public final class VerificationResponse: NSObject, Sendable {
66
/// Unix timestamp before a new verification email could be sent for the same user ID.

0 commit comments

Comments
 (0)