Generating documentation automatically with DocC

.gitignore

@@ -42,3 +42,4 @@ fastlane/sign&cert
 *.save
 ._*
 *.bak
+.build

Package.swift

@@ -25,7 +25,9 @@ let package = Package(
         .library(name: "SwedbankPaySDKMerchantBackend", targets: ["SwedbankPaySDKMerchantBackend"])
     ],
     dependencies: [
-        .package(url: "https://github.com/Alamofire/Alamofire.git", .upToNextMajor(from: "5.5.0"))
+        .package(url: "https://github.com/Alamofire/Alamofire.git", .upToNextMajor(from: "5.5.0")),
+        .package(url: "https://github.com/apple/swift-docc-plugin", .upToNextMajor(from: "1.0.0"),
+                 swiftSettings: [.unsafeFlags(["-emit-extension-block-symbols"])]),
     ],
     targets: [
         .target(

SwedbankPaySDK.xcodeproj/xcshareddata/xcschemes/SwedbankPaySDKDocumentation.xcscheme

@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1420"
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "D511EC6D2975591B0059AB05"
+               BuildableName = "SwedbankPaySDKDocumentation.framework"
+               BlueprintName = "SwedbankPaySDKDocumentation"
+               ReferencedContainer = "container:SwedbankPaySDK.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <Testables>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "D511EC6D2975591B0059AB05"
+            BuildableName = "SwedbankPaySDKDocumentation.framework"
+            BlueprintName = "SwedbankPaySDKDocumentation"
+            ReferencedContainer = "container:SwedbankPaySDK.xcodeproj">
+         </BuildableReference>
+      </MacroExpansion>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

SwedbankPaySDK/Classes/SwedbankPaySDK+Extensions/Configuration.swift

@@ -178,6 +178,7 @@ public protocol SwedbankPaySDKConfiguration {
     func url(_ url: URL, matchesPaymentUrl paymentUrl: URL) -> Bool
 }
 
+///This error is thrown when calling optional methods without implementing them first.
 public struct NotImplementedError: Error {
 
     var description: String {

SwedbankPaySDKDocumentation-Info.plist

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
+	<key>CFBundleShortVersionString</key>
+	<string>3.0</string>
+	<key>CFBundleVersion</key>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
+</dict>
+</plist>

docs/SwedbankPaySDK.doccarchive/data/documentation/swedbankpaysdk.json

@@ -0,0 +1 @@
+{"variants":[{"paths":["\/documentation\/swedbankpaysdk"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK","interfaceLanguage":"swift"},"topicSections":[{"title":"Classes","identifiers":["doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDK","doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDKController"]},{"title":"Protocols","identifiers":["doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDKConfiguration","doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDKConfigurationAsync","doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDKConfigurationWithCallbackScheme","doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDKDelegate","doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDKRequest"]},{"title":"Structures","identifiers":["doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/NotImplementedError"]}],"kind":"symbol","metadata":{"roleHeading":"Framework","externalID":"SwedbankPaySDK","title":"SwedbankPaySDK","symbolKind":"module","role":"collection","modules":[{"name":"SwedbankPaySDK"}]},"hierarchy":{"paths":[[]]},"references":{"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK":{"role":"collection","title":"SwedbankPaySDK","abstract":[],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK","kind":"symbol","type":"topic","url":"\/documentation\/swedbankpaysdk"},"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK/SwedbankPaySDKConfigurationAsync":{"role":"symbol","title":"SwedbankPaySDKConfigurationAsync","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SwedbankPaySDKConfigurationAsync"}],"abstract":[{"type":"text","text":"The "},{"type":"codeVoice","code":"SwedbankPaySDKConfigurationAsync"},{"type":"text","text":" protocol allows you to implement your"},{"type":"text","text":" "},{"type":"codeVoice","code":"SwedbankPaySDKConfiguration"},{"type":"text","text":" in terms of "},{"type":"codeVoice","code":"async"},{"type":"text","text":" functions."}],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDKConfigurationAsync","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SwedbankPaySDKConfigurationAsync"}],"url":"\/documentation\/swedbankpaysdk\/swedbankpaysdkconfigurationasync"},"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK/SwedbankPaySDKController":{"role":"symbol","title":"SwedbankPaySDKController","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SwedbankPaySDKController"}],"abstract":[{"type":"text","text":"Swedbank Pay SDK ViewController, initialize this to start the payment process"}],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDKController","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SwedbankPaySDKController"}],"url":"\/documentation\/swedbankpaysdk\/swedbankpaysdkcontroller"},"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK/SwedbankPaySDK":{"role":"symbol","title":"SwedbankPaySDK","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SwedbankPaySDK"}],"abstract":[{"type":"text","text":"Class defining data types exposed to the client app using the SDK"}],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDK","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SwedbankPaySDK"}],"url":"\/documentation\/swedbankpaysdk\/swedbankpaysdk"},"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK/SwedbankPaySDKRequest":{"role":"symbol","title":"SwedbankPaySDKRequest","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SwedbankPaySDKRequest"}],"abstract":[{"type":"text","text":"A handle to a request started by a call to SwedbankPaySDKConfiguration."}],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDKRequest","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SwedbankPaySDKRequest"}],"url":"\/documentation\/swedbankpaysdk\/swedbankpaysdkrequest"},"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK/SwedbankPaySDKConfigurationWithCallbackScheme":{"role":"symbol","title":"SwedbankPaySDKConfigurationWithCallbackScheme","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SwedbankPaySDKConfigurationWithCallbackScheme"}],"abstract":[{"type":"text","text":"A refinement of SwedbankPaySDKConfiguration."},{"type":"text","text":" "},{"type":"text","text":"SwedbankPaySDKConfigurationWithCallbackScheme uses knowledge of the"},{"type":"text","text":" "},{"type":"text","text":"custom scheme used for "},{"type":"codeVoice","code":"paymentUrl"},{"type":"text","text":" to only accept"},{"type":"text","text":" "},{"type":"codeVoice","code":"paymentUrl"},{"type":"text","text":" with the original scheme or the specified scheme."}],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDKConfigurationWithCallbackScheme","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SwedbankPaySDKConfigurationWithCallbackScheme"}],"url":"\/documentation\/swedbankpaysdk\/swedbankpaysdkconfigurationwithcallbackscheme"},"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK/SwedbankPaySDKDelegate":{"role":"symbol","title":"SwedbankPaySDKDelegate","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SwedbankPaySDKDelegate"}],"abstract":[{"type":"text","text":"Swedbank Pay SDK protocol, conform to this to get the result of the payment process"}],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDKDelegate","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SwedbankPaySDKDelegate"}],"url":"\/documentation\/swedbankpaysdk\/swedbankpaysdkdelegate"},"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK/SwedbankPaySDKConfiguration":{"role":"symbol","title":"SwedbankPaySDKConfiguration","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SwedbankPaySDKConfiguration"}],"abstract":[{"type":"text","text":"A SwedbankPaySDKConfiguration is responsible for"},{"type":"text","text":" "},{"type":"text","text":"creating and manipulating Consumer Identification Sessions"},{"type":"text","text":" "},{"type":"text","text":"and Payment Orders as required by the SwedbankPaySDKController."}],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/SwedbankPaySDKConfiguration","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SwedbankPaySDKConfiguration"}],"url":"\/documentation\/swedbankpaysdk\/swedbankpaysdkconfiguration"},"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK/NotImplementedError":{"role":"symbol","title":"NotImplementedError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"NotImplementedError"}],"abstract":[{"type":"text","text":"This error is thrown when calling optional methods without implementing them first."}],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/NotImplementedError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"NotImplementedError"}],"url":"\/documentation\/swedbankpaysdk\/notimplementederror"}}}

docs/SwedbankPaySDK.doccarchive/data/documentation/swedbankpaysdk/notimplementederror.json

@@ -0,0 +1 @@
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"NotImplementedError"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swedbankpaysdk\/notimplementederror"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/com.swedbank.SwedbankPaySDK\/s5ErrorP","doc:\/\/com.swedbank.SwedbankPaySDK\/s8SendableP"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/NotImplementedError","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"This error is thrown when calling optional methods without implementing them first."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"NotImplementedError"}],"title":"NotImplementedError","roleHeading":"Structure","role":"symbol","symbolKind":"struct","externalID":"s:14SwedbankPaySDK19NotImplementedErrorV","modules":[{"name":"SwedbankPaySDK"}],"navigatorTitle":[{"kind":"identifier","text":"NotImplementedError"}]},"hierarchy":{"paths":[["doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK"]]},"topicSections":[{"title":"Default Implementations","identifiers":["doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/NotImplementedError\/Error-Implementations"],"generated":true}],"references":{"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK/NotImplementedError":{"role":"symbol","title":"NotImplementedError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"NotImplementedError"}],"abstract":[{"type":"text","text":"This error is thrown when calling optional methods without implementing them first."}],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/NotImplementedError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"NotImplementedError"}],"url":"\/documentation\/swedbankpaysdk\/notimplementederror"},"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK":{"role":"collection","title":"SwedbankPaySDK","abstract":[],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK","kind":"symbol","type":"topic","url":"\/documentation\/swedbankpaysdk"},"doc://com.swedbank.SwedbankPaySDK/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/s8SendableP"},"doc://com.swedbank.SwedbankPaySDK/s5ErrorP":{"type":"unresolvable","title":"Swift.Error","identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/s5ErrorP"},"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK/NotImplementedError/Error-Implementations":{"role":"collectionGroup","title":"Error Implementations","abstract":[],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/NotImplementedError\/Error-Implementations","kind":"article","type":"topic","url":"\/documentation\/swedbankpaysdk\/notimplementederror\/error-implementations"}}}

docs/SwedbankPaySDK.doccarchive/data/documentation/swedbankpaysdk/notimplementederror/error-implementations.json

@@ -0,0 +1 @@
+{"variants":[{"paths":["\/documentation\/swedbankpaysdk\/notimplementederror\/error-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/NotImplementedError\/Error-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/NotImplementedError\/localizedDescription"],"generated":true}],"kind":"article","metadata":{"modules":[{"name":"SwedbankPaySDK"}],"role":"collectionGroup","title":"Error Implementations"},"hierarchy":{"paths":[["doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK","doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/NotImplementedError"]]},"references":{"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK/NotImplementedError/localizedDescription":{"role":"symbol","title":"localizedDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/NotImplementedError\/localizedDescription","kind":"symbol","type":"topic","url":"\/documentation\/swedbankpaysdk\/notimplementederror\/localizeddescription"},"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK/NotImplementedError":{"role":"symbol","title":"NotImplementedError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"NotImplementedError"}],"abstract":[{"type":"text","text":"This error is thrown when calling optional methods without implementing them first."}],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK\/NotImplementedError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"NotImplementedError"}],"url":"\/documentation\/swedbankpaysdk\/notimplementederror"},"doc://com.swedbank.SwedbankPaySDK/documentation/SwedbankPaySDK":{"role":"collection","title":"SwedbankPaySDK","abstract":[],"identifier":"doc:\/\/com.swedbank.SwedbankPaySDK\/documentation\/SwedbankPaySDK","kind":"symbol","type":"topic","url":"\/documentation\/swedbankpaysdk"}}}