.jazzy.yaml

author: Nevis Security AG
copyright: '© 2022 Nevis Security AG. All rights reserved.'
module: NevisExampleApp

clean: true
theme: fullwidth
output: Docs/generated
include: 'NevisExampleApp/*'
exclude: 'Pods/*'
skip_undocumented: true
hide_documentation_coverage: true
xcodebuild_arguments:
    - '-workspace'
    - 'NevisExampleApp.xcworkspace'
    - '-scheme'
    - 'NevisExampleApp'

custom_categories:
  - name: Application
    children:
      - AppDelegate
  - name: Configuration
    children:
      - ConfigurationLoader
      - ConfigurationLoaderImpl
      - AppConfiguration
      - LoginConfiguration
      - Environment
  - name: Coordinator
    children:
      - Coordinator
      - NavigationParameterizable
      - AppCoordinator
      - AppCoordinatorImpl
  - name: Dependency Provider
    children:
      - AppAssembly
      - DependencyProvider
  - name: Error
    children:
      - AppError
      - ErrorHandlerChain
      - ErrorHandlerChainImpl
      - ErrorHandler
      - GeneralErrorHandlerName
      - GeneralErrorHandler
      - NevisErrorHandlerName
      - NevisErrorHandler
  - name: Interaction
    children:
      - AccountSelectorImpl
      - AuthenticatorSelectorImpl
      - AuthenticationAuthenticatorSelectorName
      - BiometricUserVerifierImpl
      - DevicePasscodeUserVerifierImpl
      - OutOfBandOperationHandler
      - OutOfBandOperationHandlerImpl
      - PinChangerImpl
      - PinEnrollerImpl
      - PinUserVerifierImpl
      - PasswordChangerImpl
      - PasswordEnrollerImpl
      - PasswordUserVerifierImpl
      - RegistrationAuthenticatorSelectorName
  - name: Model
    children:
      - AuthenticatorItem
      - DeepLink
      - Operation
      - OperationError

  - name: Screens
    children:
      - Screen
      - BaseScreen
      - BaseView
      - LaunchScreen
      - LaunchPresenter
      - HomeScreen
      - HomePresenter
      - QrScannerScreen
      - QrScannerPresenter
      - SelectAccountScreen
      - SelectAccountPresenter
      - SelectAccountParameter
      - SelectAccountItemViewModel
      - AccountCell
      - SelectAuthenticatorScreen
      - SelectAuthenticatorPresenter
      - SelectAuthenticatorParameter
      - SelectAuthenticatorItemViewModel
      - AuthenticatorCell
      - CredentialScreen
      - CredentialView
      - CredentialPresenter
      - CredentialParameter
      - PinParameter
      - PasswordParameter
      - CredentialProtectionInformation
      - AuthCloudApiRegistrationScreen
      - AuthCloudApiRegistrationPresenter
      - ChangeDeviceInformationScreen
      - ChangeDeviceInformationPresenter
      - ChangeDeviceInformationParameter
      - UsernamePasswordLoginScreen
      - UsernamePasswordLoginPresenter
      - TransactionConfirmationScreen
      - TransactionConfirmationPresenter
      - TransactionConfirmationParameter
      - ConfirmationScreen
      - ConfirmationPresenter
      - ConfirmationParameter
      - ResultScreen
      - ResultPresenter
      - ResultParameter
      - LoggingScreen
      - LoggingView
      - LoggingPresenter
  - name: Utility / Client Provider
    children:
      - ClientProvider
      - ClientProviderImpl
  - name: Utility / Timer
    children:
      - InteractionCountDownTimer
  - name: Utility / Extensions
    children:
      - Authenticator
      - AuthenticatorAaid
      - '[String: String]'
      - Notification
      - OSLog
      - PinAuthenticatorProtectionStatus
      - PasswordAuthenticatorProtectionStatus
      - String
      - String?
      - UIApplication
      - UIDevice
      - UINavigationController
      - UIStackView
      - UIView
      - UIViewController      
  - name: Utility / Localization
    children:
      - L10n
  - name: Utility / Logger
    children:
      - SDKLogger
      - SDKLoggerImpl
  - name: Utility / Login
    children:
      - LoginService
      - LoginServiceImpl
      - LoginSessionDelegate
      - LoginRequest
      - LoginResponse
  - name: Utility / UI
    children:
      - NSLabel
      - NSTextField
      - OutlinedButton
      - Style
  - name: Utility / Validation
    children:
      - AccountValidator
      - AuthenticatorValidator
      - AuthCloudApiRegistrationValidator
      - LoginValidator
      - ValidationResult
      - PasswordPolicyImpl
      - PasswordPolicyError