forked from verygoodsecurity/vgs-collect-ios
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path.jazzy.yaml
109 lines (108 loc) · 2.53 KB
/
.jazzy.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
####################
# Comments
# 1. pods should be installed/updated
# 2. jazzy command should be running form framework root dir
####################
#names
module: VGSCollectSDK
title: VGSCollectSDK
author: Very Good Security
author_url: https://verygoodsecurity.com
github_url: https://github.com/verygoodsecurity/vgs-collect-ios
github_file_prefix: https://github.com/verygoodsecurity/vgs-collect-ios/tree/master
readme: README.md
#output folder
output: docs
#path to project
framework_root: ../
sdk: iphonesimulator
#settings
clean: true
objc: false
skip_undocumented: true
hide_documentation_coverage: true
theme: fullwidth
exclude:
Sources/VGSCollectSDK/Core/Utils.swift
custom_categories:
- name: UI Elements
children:
- VGSTextField
- VGSCardTextField
- VGSExpDateTextField
- VGSCVCTextField
- VGSTextFieldDelegate
- VGSConfiguration
- VGSExpDateConfiguration
- FieldType
- name: Card Scan
children:
- VGSCardIOScanController
- VGSCardIOScanControllerDelegate
- CradIODataType
- name: File Picker
children:
- VGSFilePickerController
- VGSFilePickerConfiguration
- VGSFilePickerControllerDelegate
- VGSFileSource
- VGSFileInfo
- name: Observe State and Send Data
children:
- VGSCollect
- Environment
- State
- SSNState
- CardState
- VGSResponse
- VGSCollectRequestOptions
- JsonData
- HTTPMethod
- HTTPHeaders
- name: Payment Cards
children:
- VGSPaymentCards
- VGSPaymentCardModel
- VGSCustomPaymentCardModel
- VGSUnknownPaymentCardModel
- name: VGSTextField Serializers
children:
- VGSFormatSerializerProtocol
- VGSExpDateSeparateSerializer
- name: Validation Rules
children:
- VGSValidationRuleSet
- VGSValidationRuleLength
- VGSValidationRuleLengthMatch
- VGSValidationRulePattern
- VGSValidationRulePaymentCard
- VGSValidationRuleLuhnCheck
- VGSValidationRuleCardExpirationDate
- CheckSumAlgorithmType
- CardExpDateFormat
- name: Errors
children:
- VGSError
- VGSErrorType
- VGSCollectSDKErrorDomain
- VGSValidationError
- VGSValidationErrorType
- name: Error Keys
children:
- VGSSDKErrorInputDataIsNotValid
- VGSSDKErrorInputDataRequired
- VGSSDKErrorInputDataRequiredValid
- VGSSDKErrorFileNotFound
- VGSSDKErrorFileTypeNotSupported
- VGSSDKErrorFileSizeExceedsTheLimit
- VGSSDKErrorSourceNotAvailable
- VGSSDKErrorUnexpectedResponseDataFormat
- name: Debugging
children:
- VGSCollectLogger
- VGSLogLevel
- VGSCollectLoggingConfiguration
- name: Enumerations
children:
- VGSCardExpDateFormat
- VGSCollectFieldNameMappingPolicy