Skip to content

Commit

Permalink
NEVISACCESSAPP-6400: Migrate to DocC
Browse files Browse the repository at this point in the history
- Updated source code documentation to meet with DocC requirements
- Added documentation catalog
- Removed Jazzy configuration file
- `SDKLogger` is replaced with `Logger`
  • Loading branch information
tamas-toth committed Jan 23, 2025
1 parent f3e6361 commit 2f73301
Show file tree
Hide file tree
Showing 59 changed files with 480 additions and 595 deletions.
171 changes: 0 additions & 171 deletions .jazzy.yaml

This file was deleted.

20 changes: 8 additions & 12 deletions NevisExampleApp.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,12 @@
3859EBB7292CFA1900013472 /* Strings.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3859EB96292CFA1900013472 /* Strings.swift */; };
3859EBBB292CFA7000013472 /* String+Extension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3859EBB8292CFA7000013472 /* String+Extension.swift */; };
3859EBBC292CFA7000013472 /* UIDevice+Extension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3859EBB9292CFA7000013472 /* UIDevice+Extension.swift */; };
3859EBBD292CFA7000013472 /* OSLog+Extension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3859EBBA292CFA7000013472 /* OSLog+Extension.swift */; };
3859EBC1292CFAB100013472 /* SDKLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3859EBBF292CFAB100013472 /* SDKLogger.swift */; };
3859EBC2292CFAB100013472 /* SDKLoggerImpl.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3859EBC0292CFAB100013472 /* SDKLoggerImpl.swift */; };
3859EBC4292CFB0500013472 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3859EBC3292CFB0500013472 /* AppDelegate.swift */; };
3859EBC6292D085600013472 /* BaseView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3859EBC5292D085600013472 /* BaseView.swift */; };
3859EBC8292D096100013472 /* UIViewController+Extension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3859EBC7292D096100013472 /* UIViewController+Extension.swift */; };
3872BFCE2A29D18F0041C594 /* AuthenticatorItem.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3872BFCD2A29D18F0041C594 /* AuthenticatorItem.swift */; };
388DBCDF2D40F7DA005CD4B3 /* Documentation.docc in Sources */ = {isa = PBXBuildFile; fileRef = 388DBCDE2D40F7DA005CD4B3 /* Documentation.docc */; };
388DBCE12D411857005CD4B3 /* Logger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 388DBCE02D411857005CD4B3 /* Logger.swift */; };
38A68C5D29253BAB00685419 /* ConfigAuthenticationCloud.plist in Resources */ = {isa = PBXBuildFile; fileRef = 38821E6F292502670009522A /* ConfigAuthenticationCloud.plist */; };
38A68C5E29253BAB00685419 /* ConfigIdentitySuite.plist in Resources */ = {isa = PBXBuildFile; fileRef = 38821E6D292500ED0009522A /* ConfigIdentitySuite.plist */; };
38C1B379269D815A00ED5782 /* Localizable.strings in Resources */ = {isa = PBXBuildFile; fileRef = 38C1B37B269D815A00ED5782 /* Localizable.strings */; };
Expand Down Expand Up @@ -213,15 +212,14 @@
3859EB96292CFA1900013472 /* Strings.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Strings.swift; sourceTree = "<group>"; };
3859EBB8292CFA7000013472 /* String+Extension.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "String+Extension.swift"; sourceTree = "<group>"; };
3859EBB9292CFA7000013472 /* UIDevice+Extension.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "UIDevice+Extension.swift"; sourceTree = "<group>"; };
3859EBBA292CFA7000013472 /* OSLog+Extension.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "OSLog+Extension.swift"; sourceTree = "<group>"; };
3859EBBF292CFAB100013472 /* SDKLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SDKLogger.swift; sourceTree = "<group>"; };
3859EBC0292CFAB100013472 /* SDKLoggerImpl.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SDKLoggerImpl.swift; sourceTree = "<group>"; };
3859EBC3292CFB0500013472 /* AppDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = "<group>"; };
3859EBC5292D085600013472 /* BaseView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BaseView.swift; sourceTree = "<group>"; };
3859EBC7292D096100013472 /* UIViewController+Extension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "UIViewController+Extension.swift"; sourceTree = "<group>"; };
3872BFCD2A29D18F0041C594 /* AuthenticatorItem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AuthenticatorItem.swift; sourceTree = "<group>"; };
38821E6D292500ED0009522A /* ConfigIdentitySuite.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = ConfigIdentitySuite.plist; sourceTree = "<group>"; };
38821E6F292502670009522A /* ConfigAuthenticationCloud.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = ConfigAuthenticationCloud.plist; sourceTree = "<group>"; };
388DBCDE2D40F7DA005CD4B3 /* Documentation.docc */ = {isa = PBXFileReference; lastKnownFileType = folder.documentationcatalog; path = Documentation.docc; sourceTree = "<group>"; };
388DBCE02D411857005CD4B3 /* Logger.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Logger.swift; sourceTree = "<group>"; };
38C1B37A269D815A00ED5782 /* en */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = en; path = en.lproj/Localizable.strings; sourceTree = "<group>"; };
38DABD6329D581D3008B8116 /* UsernamePasswordLoginScreen.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsernamePasswordLoginScreen.swift; sourceTree = "<group>"; };
38DABD6429D581D3008B8116 /* UsernamePasswordLoginPresenter.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UsernamePasswordLoginPresenter.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -291,6 +289,7 @@
3833EB1B2685EA03002C5E0C /* NevisExampleApp */ = {
isa = PBXGroup;
children = (
388DBCDE2D40F7DA005CD4B3 /* Documentation.docc */,
3859EAE0292CF82D00013472 /* Configuration */,
3859EAD1292CF78900013472 /* Coordinator */,
3859EADB292CF7F000013472 /* Dependency Provider */,
Expand Down Expand Up @@ -594,7 +593,6 @@
06471B142C29685C006879F9 /* AuthenticatorAaid+Extensions.swift */,
3859EB84292CFA1900013472 /* Dictionary+Extension.swift */,
3859EB83292CFA1900013472 /* Notification+Extension.swift */,
3859EBBA292CFA7000013472 /* OSLog+Extension.swift */,
06000BAB2C37DDDD00AB53A1 /* PasswordAuthenticatorProtectionStatus+Extension.swift */,
3859EB82292CFA1900013472 /* PinAuthenticatorProtectionStatus+Extension.swift */,
3859EBB8292CFA7000013472 /* String+Extension.swift */,
Expand Down Expand Up @@ -660,8 +658,7 @@
3859EBBE292CFAB100013472 /* Logger */ = {
isa = PBXGroup;
children = (
3859EBBF292CFAB100013472 /* SDKLogger.swift */,
3859EBC0292CFAB100013472 /* SDKLoggerImpl.swift */,
388DBCE02D411857005CD4B3 /* Logger.swift */,
);
path = Logger;
sourceTree = "<group>";
Expand Down Expand Up @@ -787,7 +784,6 @@
files = (
3859EBA8292CFA1900013472 /* PinAuthenticatorProtectionStatus+Extension.swift in Sources */,
3859EB48292CF92000013472 /* LaunchPresenter.swift in Sources */,
3859EBC2292CFAB100013472 /* SDKLoggerImpl.swift in Sources */,
3859EB3B292CF92000013472 /* AccountSelectorImpl.swift in Sources */,
3859EB9D292CFA1900013472 /* InteractionCountDownTimer.swift in Sources */,
3859EBAF292CFA1900013472 /* LoginServiceImpl.swift in Sources */,
Expand All @@ -802,6 +798,7 @@
3859EB4D292CF92000013472 /* AccountCell.swift in Sources */,
3859EBA4292CFA1900013472 /* UINavigationController+Extension.swift in Sources */,
3859EBB0292CFA1900013472 /* LoginRequest.swift in Sources */,
388DBCE12D411857005CD4B3 /* Logger.swift in Sources */,
3859EB49292CF92000013472 /* LaunchScreen.swift in Sources */,
3859EBA9292CFA1900013472 /* Notification+Extension.swift in Sources */,
3859EB55292CF92000013472 /* LoggingPresenter.swift in Sources */,
Expand Down Expand Up @@ -843,6 +840,7 @@
3859EBB3292CFA1900013472 /* AccountValidator.swift in Sources */,
3859EAF8292CF8A800013472 /* AppError.swift in Sources */,
3859EB68292CF9AF00013472 /* Operation.swift in Sources */,
388DBCDF2D40F7DA005CD4B3 /* Documentation.docc in Sources */,
3859EB36292CF92000013472 /* PinUserVerifierImpl.swift in Sources */,
3859EB45292CF92000013472 /* ResultScreen.swift in Sources */,
3859EADF292CF7F000013472 /* AppAssembly.swift in Sources */,
Expand All @@ -852,10 +850,8 @@
3859EAD9292CF78900013472 /* NavigationParameterizable.swift in Sources */,
3859EBAA292CFA1900013472 /* Dictionary+Extension.swift in Sources */,
3859EBC6292D085600013472 /* BaseView.swift in Sources */,
3859EBC1292CFAB100013472 /* SDKLogger.swift in Sources */,
3859EAF9292CF8A800013472 /* ErrorHandlerChain.swift in Sources */,
3859EAEA292CF82D00013472 /* Environment.swift in Sources */,
3859EBBD292CFA7000013472 /* OSLog+Extension.swift in Sources */,
3859EB46292CF92000013472 /* ChangeDeviceInformationScreen.swift in Sources */,
3859EB99292CFA1900013472 /* Style.swift in Sources */,
06000BB02C37EDA100AB53A1 /* PasswordEnroller.swift in Sources */,
Expand Down
13 changes: 7 additions & 6 deletions NevisExampleApp/AppDelegate.swift
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ import UIKit
class AppDelegate: UIResponder, UIApplicationDelegate {

/// Tells the delegate that the launch process is almost done and the app is almost ready to run.
/// Use this method (and the corresponding application(_:willFinishLaunchingWithOptions:) method) to complete your app’s initialization and make any final tweaks.
///
/// - Parameters:
/// - application: The singleton app object.
/// - launchOptions: A dictionary indicating the reason the app was launched (if any). The contents of this dictionary may be empty in situations where the user launched the app directly.
/// - Returns: Returns *false* if the app cannot handle the URL resource or continue a user activity, otherwise return *true*. The return value is ignored if the app is launched as a result of a remote notification.
func application(_: UIApplication, didFinishLaunchingWithOptions _: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// swiftformat:disable:next unusedArguments
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
let appCoordinator = DependencyProvider.shared.container.resolve(AppCoordinator.self)
appCoordinator?.start()
return true
Expand All @@ -31,11 +31,12 @@ extension AppDelegate {
/// Asks the delegate to open a resource specified by a URL, and provides a dictionary of launch options.
///
/// - Parameters:
/// - app: The singleton app object.
/// - application: The singleton app object.
/// - url: The URL resource to open. This resource can be a network resource or a file. For information about the Apple-registered URL schemes, see Apple URL Scheme Reference.
/// - options: A dictionary of URL handling options. For information about the possible keys in this dictionary and how to handle them, see UIApplicationOpenURLOptionsKey. By default, the value of this parameter is an empty dictionary.
/// - Returns: *true* if the delegate successfully handled the request or *false* if the attempt to open the URL resource failed.
func application(_: UIApplication, open url: URL, options _: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
/// - options: A dictionary of URL handling options. For information about the possible keys in this dictionary and how to handle them, see `UIApplicationOpenURLOptionsKey`. By default, the value of this parameter is an empty dictionary.
/// - Returns: Returns *true* if the delegate successfully handled the request or *false* if the attempt to open the URL resource failed.
// swiftformat:disable:next unusedArguments
func application(_ application: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
handleUrl(url)
}

Expand Down
Loading

0 comments on commit 2f73301

Please sign in to comment.