diff --git a/Classes.html b/Classes.html index dcb911029..d6394283c 100644 --- a/Classes.html +++ b/Classes.html @@ -67,9 +67,6 @@
-
-
- ConfigurationElement
-
- A single parameter of a rule configuration.
- -Apply it to a simple (e.g. boolean) property like
-@ConfigurationElement(key: "name")
-var property = true
-
-
-If the wrapped element is an InlinableOptionType, there are two options for its representation
-in the documentation:
swift
-@ConfigurationElement(key: "name")
-var property = true
-@ConfigurationElement
-var levels = SeverityLevelsConfiguration(warning: 1, error: 2)
-
-will be documented as a linear list:
-
-name: true
-warning: 1
-error: 2
-swift
-@ConfigurationElement(key: "name")
-var property = true
-@ConfigurationElement(key: "levels")
-var levels = SeverityLevelsConfiguration(warning: 1, error: 2)
-
-will have a nested configuration section:
-
-name: true
-levels: warning: 1
- error: 2
-Swift
-@propertyWrapper
-public class ConfigurationElement<T> where T : Equatable, T : AcceptableByConfigurationElement
-extension ConfigurationElement: Equatable
-
-
diff --git a/Classes/CustomRuleTimer.html b/Classes/CustomRuleTimer.html
index 0fc9d344c..dfa49aa82 100644
--- a/Classes/CustomRuleTimer.html
+++ b/Classes/CustomRuleTimer.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Classes/DeclaredIdentifiersTrackingVisitor.html b/Classes/DeclaredIdentifiersTrackingVisitor.html
index 40556addb..7937a7a53 100644
--- a/Classes/DeclaredIdentifiersTrackingVisitor.html
+++ b/Classes/DeclaredIdentifiersTrackingVisitor.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Classes/LinterCache.html b/Classes/LinterCache.html
index 54a9af65b..f4fb8669c 100644
--- a/Classes/LinterCache.html
+++ b/Classes/LinterCache.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Classes/RuleRegistry.html b/Classes/RuleRegistry.html
index 946e7721e..168f6c897 100644
--- a/Classes/RuleRegistry.html
+++ b/Classes/RuleRegistry.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Classes/RuleStorage.html b/Classes/RuleStorage.html
index adcbb18f2..f418caf39 100644
--- a/Classes/RuleStorage.html
+++ b/Classes/RuleStorage.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Classes/SwiftLintFile.html b/Classes/SwiftLintFile.html
index c1f887b7e..8ffd85ba2 100644
--- a/Classes/SwiftLintFile.html
+++ b/Classes/SwiftLintFile.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Classes/ViolationsSyntaxRewriter.html b/Classes/ViolationsSyntaxRewriter.html
index ae26162ad..9662819b7 100644
--- a/Classes/ViolationsSyntaxRewriter.html
+++ b/Classes/ViolationsSyntaxRewriter.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Classes/ViolationsSyntaxVisitor.html b/Classes/ViolationsSyntaxVisitor.html
index 7b1758b89..4eafb9fc3 100644
--- a/Classes/ViolationsSyntaxVisitor.html
+++ b/Classes/ViolationsSyntaxVisitor.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Enums.html b/Enums.html
index fb45d94f2..0cc392e88 100644
--- a/Enums.html
+++ b/Enums.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Enums/AccessControlLevel.html b/Enums/AccessControlLevel.html
index 5abb3e454..c3823594d 100644
--- a/Enums/AccessControlLevel.html
+++ b/Enums/AccessControlLevel.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Enums/ExecutableInfo.html b/Enums/ExecutableInfo.html
index bf3a811e0..be38d04a3 100644
--- a/Enums/ExecutableInfo.html
+++ b/Enums/ExecutableInfo.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Enums/Issue.html b/Enums/Issue.html
index c41a6ab53..8cda353e8 100644
--- a/Enums/Issue.html
+++ b/Enums/Issue.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Enums/OptionType.html b/Enums/OptionType.html
index ce7778e1f..2b88a1cea 100644
--- a/Enums/OptionType.html
+++ b/Enums/OptionType.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Enums/RuleIdentifier.html b/Enums/RuleIdentifier.html
index 3bc37b4f5..2014fecc0 100644
--- a/Enums/RuleIdentifier.html
+++ b/Enums/RuleIdentifier.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Enums/RuleKind.html b/Enums/RuleKind.html
index 68c1a6e86..ae4d4ba1c 100644
--- a/Enums/RuleKind.html
+++ b/Enums/RuleKind.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Enums/RuleListError.html b/Enums/RuleListError.html
index 4f3fcb6ba..d5c4b3d61 100644
--- a/Enums/RuleListError.html
+++ b/Enums/RuleListError.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Enums/SwiftExpressionKind.html b/Enums/SwiftExpressionKind.html
index b0e11716e..e0155caec 100644
--- a/Enums/SwiftExpressionKind.html
+++ b/Enums/SwiftExpressionKind.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Enums/ViolationSeverity.html b/Enums/ViolationSeverity.html
index abee6d712..afdc15e7b 100644
--- a/Enums/ViolationSeverity.html
+++ b/Enums/ViolationSeverity.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Extensions.html b/Extensions.html
index f46db3fc0..5c0be1f5d 100644
--- a/Extensions.html
+++ b/Extensions.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Extensions/Array.html b/Extensions/Array.html
index b713fda08..b0c89d9fd 100644
--- a/Extensions/Array.html
+++ b/Extensions/Array.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
@@ -549,7 +549,7 @@
An option type that does not need a key when used in a ConfigurationElement. Its value will be inlined.
An option type that does not need a key when used in a ConfigurationElement. Its value will be inlined.
+
+
+ ConfigurationElement
+
+ A single parameter of a rule configuration.
+ +Apply it to a simple (e.g. boolean) property like
+@ConfigurationElement(key: "name")
+var property = true
+
+
+If the wrapped element is an InlinableOptionType, there are two options for its representation
+in the documentation:
swift
+@ConfigurationElement(key: "name")
+var property = true
+@ConfigurationElement
+var levels = SeverityLevelsConfiguration(warning: 1, error: 2)
+
+will be documented as a linear list:
+
+name: true
+warning: 1
+error: 2
+swift
+@ConfigurationElement(key: "name")
+var property = true
+@ConfigurationElement(key: "levels")
+var levels = SeverityLevelsConfiguration(warning: 1, error: 2)
+
+will have a nested configuration section:
+
+name: true
+levels: warning: 1
+ error: 2
+Swift
+@propertyWrapper
+public struct ConfigurationElement<T> : Equatable where T : Equatable, T : AcceptableByConfigurationElement
+
+
diff --git a/Structs/ChildOptionSeverityConfiguration.html b/Structs/ChildOptionSeverityConfiguration.html
index 932cbf35b..0e27b8ac3 100644
--- a/Structs/ChildOptionSeverityConfiguration.html
+++ b/Structs/ChildOptionSeverityConfiguration.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Structs/CollectedLinter.html b/Structs/CollectedLinter.html
index 26f5d8152..286c70d96 100644
--- a/Structs/CollectedLinter.html
+++ b/Structs/CollectedLinter.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Structs/Command.html b/Structs/Command.html
index 35668e056..4ef73e3f3 100644
--- a/Structs/Command.html
+++ b/Structs/Command.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Structs/Command/Action.html b/Structs/Command/Action.html
index 2a05ed0d2..493ded7bb 100644
--- a/Structs/Command/Action.html
+++ b/Structs/Command/Action.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Structs/Command/Modifier.html b/Structs/Command/Modifier.html
index b133bf5e7..8f1015dcb 100644
--- a/Structs/Command/Modifier.html
+++ b/Structs/Command/Modifier.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Structs/Configuration.html b/Structs/Configuration.html
index 78707670f..3ca9283cf 100644
--- a/Structs/Configuration.html
+++ b/Structs/Configuration.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/Classes/ConfigurationElement.html b/Structs/ConfigurationElement.html
similarity index 88%
rename from Classes/ConfigurationElement.html
rename to Structs/ConfigurationElement.html
index e2f36abf3..496fbf9c1 100644
--- a/Classes/ConfigurationElement.html
+++ b/Structs/ConfigurationElement.html
@@ -1,7 +1,7 @@
- ConfigurationElement Class Reference
+ ConfigurationElement Structure Reference
@@ -14,9 +14,9 @@
-
+
-
+
@@ -50,7 +50,7 @@
SwiftLintCore Reference
- ConfigurationElement Class Reference
+ ConfigurationElement Structure Reference
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
@@ -338,8 +338,7 @@
@propertyWrapper
-public class ConfigurationElement<T> where T : Equatable, T : AcceptableByConfigurationElement
-extension ConfigurationElement: Equatable
+public struct ConfigurationElement<T> : Equatable where T : Equatable, T : AcceptableByConfigurationElement
@@ -383,7 +382,7 @@ levels: warning: 1
-
+
- wrappedValue
+ wrappedValue
-
+
- projectedValue
+ projectedValue
The option’s name. This field can only be accessed by the element’s name prefixed with a $.
The wrapper itself providing access to all its data. This field can only be accessed by the
+element’s name prefixed with a $.
Swift
-public var projectedValue: ConfigurationElement { get }
+ public var projectedValue: ConfigurationElement { get set }
Swift
-public init(wrappedValue value: T, key: String, postprocessor: @escaping (inout T) throws -> Void = { _ in })
+ public init(wrappedValue value: T, key: String, postprocessor: @escaping (inout T) throws -> Void = { _ in })
-
+
- init(key:)
+ init(key:)
Swift
-public convenience init<Wrapped>(key: String) where T == Wrapped?, Wrapped : Equatable, Wrapped : AcceptableByConfigurationElement
+ public init<Wrapped>(key: String) where T == Wrapped?, Wrapped : Equatable, Wrapped : AcceptableByConfigurationElement
Swift
-public convenience init(wrappedValue value: T) where T : InlinableOptionType
+ public init(wrappedValue value: T) where T : InlinableOptionType
Swift
-public func performAfterParseOperations() throws
+ public mutating func performAfterParseOperations() throws
@@ -725,7 +712,7 @@ parent configuration in this specific case.
Swift
-@ConfigurationElement
-public var severityConfiguration: SeverityConfiguration<Parent> { get nonmutating set }
+ @ConfigurationElement
+public var severityConfiguration: SeverityConfiguration<Parent> { get set }
Swift
-@ConfigurationElement
-public var warning: Int { get nonmutating set }
+ @ConfigurationElement
+public var warning: Int { get set }
Swift
-@ConfigurationElement
-public var error: Int? { get nonmutating set }
+ @ConfigurationElement
+public var error: Int? { get set }
-
-
- ConfigurationElement
-
- A single parameter of a rule configuration.
- -Apply it to a simple (e.g. boolean) property like
-@ConfigurationElement(key: "name")
-var property = true
-
-
-If the wrapped element is an InlinableOptionType, there are two options for its representation
-in the documentation:
swift
-@ConfigurationElement(key: "name")
-var property = true
-@ConfigurationElement
-var levels = SeverityLevelsConfiguration(warning: 1, error: 2)
-
-will be documented as a linear list:
-
-name: true
-warning: 1
-error: 2
-swift
-@ConfigurationElement(key: "name")
-var property = true
-@ConfigurationElement(key: "levels")
-var levels = SeverityLevelsConfiguration(warning: 1, error: 2)
-
-will have a nested configuration section:
-
-name: true
-levels: warning: 1
- error: 2
-Swift
-@propertyWrapper
-public class ConfigurationElement<T> where T : Equatable, T : AcceptableByConfigurationElement
-extension ConfigurationElement: Equatable
-
-
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/CustomRuleTimer.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/CustomRuleTimer.html
index 0fc9d344c..dfa49aa82 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/CustomRuleTimer.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/CustomRuleTimer.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/DeclaredIdentifiersTrackingVisitor.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/DeclaredIdentifiersTrackingVisitor.html
index 40556addb..7937a7a53 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/DeclaredIdentifiersTrackingVisitor.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/DeclaredIdentifiersTrackingVisitor.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/LinterCache.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/LinterCache.html
index 54a9af65b..f4fb8669c 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/LinterCache.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/LinterCache.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleRegistry.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleRegistry.html
index 946e7721e..168f6c897 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleRegistry.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleRegistry.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleStorage.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleStorage.html
index adcbb18f2..f418caf39 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleStorage.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleStorage.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/SwiftLintFile.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/SwiftLintFile.html
index c1f887b7e..8ffd85ba2 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/SwiftLintFile.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/SwiftLintFile.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/ViolationsSyntaxRewriter.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/ViolationsSyntaxRewriter.html
index ae26162ad..9662819b7 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/ViolationsSyntaxRewriter.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/ViolationsSyntaxRewriter.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/ViolationsSyntaxVisitor.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/ViolationsSyntaxVisitor.html
index 7b1758b89..4eafb9fc3 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/ViolationsSyntaxVisitor.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/ViolationsSyntaxVisitor.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums.html
index fb45d94f2..0cc392e88 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/AccessControlLevel.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/AccessControlLevel.html
index 5abb3e454..c3823594d 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/AccessControlLevel.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/AccessControlLevel.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/ExecutableInfo.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/ExecutableInfo.html
index bf3a811e0..be38d04a3 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/ExecutableInfo.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/ExecutableInfo.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/Issue.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/Issue.html
index c41a6ab53..8cda353e8 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/Issue.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/Issue.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/OptionType.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/OptionType.html
index ce7778e1f..2b88a1cea 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/OptionType.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/OptionType.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/RuleIdentifier.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/RuleIdentifier.html
index 3bc37b4f5..2014fecc0 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/RuleIdentifier.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/RuleIdentifier.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/RuleKind.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/RuleKind.html
index 68c1a6e86..ae4d4ba1c 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/RuleKind.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/RuleKind.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/RuleListError.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/RuleListError.html
index 4f3fcb6ba..d5c4b3d61 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/RuleListError.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/RuleListError.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/SwiftExpressionKind.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/SwiftExpressionKind.html
index b0e11716e..e0155caec 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/SwiftExpressionKind.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/SwiftExpressionKind.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/ViolationSeverity.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/ViolationSeverity.html
index abee6d712..afdc15e7b 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/ViolationSeverity.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/ViolationSeverity.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Extensions.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Extensions.html
index f46db3fc0..5c0be1f5d 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Extensions.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Extensions.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Extensions/Array.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Extensions/Array.html
index b713fda08..b0c89d9fd 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Extensions/Array.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Extensions/Array.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
@@ -549,7 +549,7 @@
An option type that does not need a key when used in a ConfigurationElement. Its value will be inlined.
An option type that does not need a key when used in a ConfigurationElement. Its value will be inlined.
+
+
+ ConfigurationElement
+
+ A single parameter of a rule configuration.
+ +Apply it to a simple (e.g. boolean) property like
+@ConfigurationElement(key: "name")
+var property = true
+
+
+If the wrapped element is an InlinableOptionType, there are two options for its representation
+in the documentation:
swift
+@ConfigurationElement(key: "name")
+var property = true
+@ConfigurationElement
+var levels = SeverityLevelsConfiguration(warning: 1, error: 2)
+
+will be documented as a linear list:
+
+name: true
+warning: 1
+error: 2
+swift
+@ConfigurationElement(key: "name")
+var property = true
+@ConfigurationElement(key: "levels")
+var levels = SeverityLevelsConfiguration(warning: 1, error: 2)
+
+will have a nested configuration section:
+
+name: true
+levels: warning: 1
+ error: 2
+Swift
+@propertyWrapper
+public struct ConfigurationElement<T> : Equatable where T : Equatable, T : AcceptableByConfigurationElement
+
+
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/ChildOptionSeverityConfiguration.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/ChildOptionSeverityConfiguration.html
index 932cbf35b..0e27b8ac3 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/ChildOptionSeverityConfiguration.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/ChildOptionSeverityConfiguration.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/CollectedLinter.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/CollectedLinter.html
index 26f5d8152..286c70d96 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/CollectedLinter.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/CollectedLinter.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Command.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Command.html
index 35668e056..4ef73e3f3 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Command.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Command.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Command/Action.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Command/Action.html
index 2a05ed0d2..493ded7bb 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Command/Action.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Command/Action.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Command/Modifier.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Command/Modifier.html
index b133bf5e7..8f1015dcb 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Command/Modifier.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Command/Modifier.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Configuration.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Configuration.html
index 78707670f..3ca9283cf 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Configuration.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Configuration.html
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/ConfigurationElement.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/ConfigurationElement.html
similarity index 88%
rename from docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/ConfigurationElement.html
rename to docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/ConfigurationElement.html
index e2f36abf3..496fbf9c1 100644
--- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/ConfigurationElement.html
+++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/ConfigurationElement.html
@@ -1,7 +1,7 @@
- ConfigurationElement Class Reference
+ ConfigurationElement Structure Reference
@@ -14,9 +14,9 @@
-
+
-
+
@@ -50,7 +50,7 @@
SwiftLintCore Reference
- ConfigurationElement Class Reference
+ ConfigurationElement Structure Reference
@@ -67,9 +67,6 @@
-
Classes
- -
- ConfigurationElement
-
-
CustomRuleTimer
@@ -253,6 +250,9 @@
-
Configuration
+ -
+ ConfigurationElement
+
-
Correction
@@ -338,8 +338,7 @@
@propertyWrapper
-public class ConfigurationElement<T> where T : Equatable, T : AcceptableByConfigurationElement
-extension ConfigurationElement: Equatable
+public struct ConfigurationElement<T> : Equatable where T : Equatable, T : AcceptableByConfigurationElement
@@ -383,7 +382,7 @@ levels: warning: 1
-
+
- wrappedValue
+ wrappedValue
-
+
- projectedValue
+ projectedValue
The option’s name. This field can only be accessed by the element’s name prefixed with a $.
The wrapper itself providing access to all its data. This field can only be accessed by the
+element’s name prefixed with a $.
Swift
-public var projectedValue: ConfigurationElement { get }
+ public var projectedValue: ConfigurationElement { get set }
Swift
-public init(wrappedValue value: T, key: String, postprocessor: @escaping (inout T) throws -> Void = { _ in })
+ public init(wrappedValue value: T, key: String, postprocessor: @escaping (inout T) throws -> Void = { _ in })
-
+
- init(key:)
+ init(key:)
Swift
-public convenience init<Wrapped>(key: String) where T == Wrapped?, Wrapped : Equatable, Wrapped : AcceptableByConfigurationElement
+ public init<Wrapped>(key: String) where T == Wrapped?, Wrapped : Equatable, Wrapped : AcceptableByConfigurationElement
Swift
-public convenience init(wrappedValue value: T) where T : InlinableOptionType
+ public init(wrappedValue value: T) where T : InlinableOptionType
Swift
-public func performAfterParseOperations() throws
+ public mutating func performAfterParseOperations() throws
@@ -725,7 +712,7 @@ parent configuration in this specific case.
Swift
-@ConfigurationElement
-public var severityConfiguration: SeverityConfiguration<Parent> { get nonmutating set }
+ @ConfigurationElement
+public var severityConfiguration: SeverityConfiguration<Parent> { get set }
Swift
-@ConfigurationElement
-public var warning: Int { get nonmutating set }
+ @ConfigurationElement
+public var warning: Int { get set }
Swift
-@ConfigurationElement
-public var error: Int? { get nonmutating set }
+ @ConfigurationElement
+public var error: Int? { get set }