View on GitHub
Install in Dash
-
An irrelevant option. It will be ignored in documentation serialization.
Declaration
Swift
case empty -
A boolean flag.
Declaration
Swift
case flag(Bool) -
A string option.
Declaration
Swift
case string(String) -
Like a string option but without quotes in the serialized output.
Declaration
Swift
case symbol(String) -
An integer option.
Declaration
Swift
case integer(Int) -
A floating point number option.
Declaration
Swift
case float(Double) -
Special option for a
ViolationSeverity.Declaration
Swift
case severity(ViolationSeverity) -
A list of options.
Declaration
Swift
case list([`Self`]) -
An option which is another set of configuration options to be nested in the serialized output.
Declaration
Swift
case nested(RuleConfigurationDescription) -
Declaration
Swift
public var hasContent: Bool { get } -
Declaration
Swift
public func markdown() -> String -
Declaration
Swift
public func oneLiner() -> String -
Declaration
Swift
public func yaml() -> String
-
Operator enabling an easy way to create a configuration option.
Declaration
Swift
static func => (key: String, value: OptionType) -> RuleConfigurationOptionParameters
keyName of the option.
valueValue of the option.
Return Value
A configuration option built up by the given data.
-
Create an option defined by nested configuration description.
Declaration
Swift
static func nest(@RuleConfigurationDescriptionBuilder _ description: () -> RuleConfigurationDescription) -> OptionTypeParameters
descriptionA configuration description buildable by applying the result builder syntax.
Return Value
A configuration option with a value being another configuration description.