Regenerate docs with swift package plugin generate-documentation

Author: fruitcoder

docs/data/documentation/extractcasevalue.json

@@ -0,0 +1 @@
+{"variants":[{"paths":["\/documentation\/extractcasevalue"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue","interfaceLanguage":"swift"},"topicSections":[{"title":"Articles","identifiers":["doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue\/Documentation"],"generated":true},{"title":"Macros","identifiers":["doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue\/ExtractCaseValue(name:kind:)","doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue\/ExtractCaseValue(name:kind:defaultValue:)"]}],"kind":"symbol","metadata":{"roleHeading":"Framework","externalID":"ExtractCaseValue","title":"ExtractCaseValue","symbolKind":"module","role":"collection","modules":[{"name":"ExtractCaseValue"}]},"hierarchy":{"paths":[[]]},"references":{"doc://ExtractCaseValue/documentation/ExtractCaseValue":{"role":"collection","title":"ExtractCaseValue","abstract":[],"identifier":"doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue","kind":"symbol","type":"topic","url":"\/documentation\/extractcasevalue"},"doc://ExtractCaseValue/documentation/ExtractCaseValue/Documentation":{"role":"article","title":"ExtractCaseValue","abstract":[{"type":"text","text":"The "},{"type":"codeVoice","code":"ExtractCaseValue"},{"type":"text","text":" package provides a macro to expose assiocated values from enum cases as a computed property."}],"identifier":"doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue\/Documentation","kind":"article","type":"topic","url":"\/documentation\/extractcasevalue\/documentation"},"doc://ExtractCaseValue/documentation/ExtractCaseValue/ExtractCaseValue(name:kind:defaultValue:)":{"role":"symbol","title":"ExtractCaseValue(name:kind:defaultValue:)","fragments":[{"kind":"keyword","text":"macro"},{"kind":"text","text":" "},{"kind":"identifier","text":"ExtractCaseValue"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":">("},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"kind"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CaseExtractionKind","preciseIdentifier":"s:22ExtractCaseValueMacros0B14ExtractionKindO"},{"kind":"text","text":", "},{"kind":"externalParam","text":"defaultValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":") -> ()"}],"abstract":[{"type":"text","text":"A macro that extracts an associated value from enum cases using a default value if"},{"type":"text","text":" "},{"type":"text","text":"extraction is not possible."}],"identifier":"doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue\/ExtractCaseValue(name:kind:defaultValue:)","kind":"symbol","type":"topic","url":"\/documentation\/extractcasevalue\/extractcasevalue(name:kind:defaultvalue:)"},"doc://ExtractCaseValue/documentation/ExtractCaseValue/ExtractCaseValue(name:kind:)":{"role":"symbol","title":"ExtractCaseValue(name:kind:)","fragments":[{"kind":"keyword","text":"macro"},{"kind":"text","text":" "},{"kind":"identifier","text":"ExtractCaseValue"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":">("},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"kind"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CaseExtractionKind","preciseIdentifier":"s:22ExtractCaseValueMacros0B14ExtractionKindO"},{"kind":"text","text":") -> ()"}],"abstract":[{"type":"text","text":"A macro that extracts an associated value from enum cases."}],"identifier":"doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue\/ExtractCaseValue(name:kind:)","kind":"symbol","type":"topic","url":"\/documentation\/extractcasevalue\/extractcasevalue(name:kind:)"}}}

docs/data/documentation/extractcasevalue/documentation.json

@@ -0,0 +1 @@
+{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"row","columns":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"To extract a simple value annotate an enum with the "},{"type":"codeVoice","code":"ExtractCaseValue"},{"type":"text","text":" macro and provide the expected type as a generic along with a name for the comuted property. This will use the "},{"type":"codeVoice","code":".firstMatchingType"},{"type":"text","text":" as a default to use the first associated value in a case that matches the expected type (in this case "},{"type":"codeVoice","code":"String"},{"type":"text","text":")."}]}],"size":1},{"content":[{"type":"paragraph","inlineContent":[{"type":"image","identifier":"sample-one"}]}],"size":1}],"numberOfColumns":2},{"type":"row","columns":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the return type is optional the macro will infer "},{"type":"codeVoice","code":"nil"},{"type":"text","text":" as the default value."}]}],"size":1},{"content":[{"type":"paragraph","inlineContent":[{"type":"image","identifier":"sample-two"}]}],"size":1}],"numberOfColumns":2},{"type":"row","columns":[{"content":[{"type":"paragraph","inlineContent":[{"type":"image","identifier":"fix-it"}]}],"size":1},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Otherwise, you will get a fix-it that recommends to use a default value."}]}],"size":1}],"numberOfColumns":2},{"type":"row","columns":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also add mutliple "},{"type":"codeVoice","code":"ExtractCaseValue"},{"type":"text","text":" macros."},{"type":"text","text":" "},{"type":"image","identifier":"sample-three"}]}],"size":1}],"numberOfColumns":1}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/extractcasevalue\/documentation"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue\/Documentation","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The "},{"type":"codeVoice","code":"ExtractCaseValue"},{"type":"text","text":" package provides a macro to expose assiocated values from enum cases as a computed property."}],"kind":"article","metadata":{"roleHeading":"Article","color":{"standardColorIdentifier":"blue"},"title":"ExtractCaseValue","role":"article","modules":[{"name":"ExtractCaseValue"}]},"hierarchy":{"paths":[["doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue"]]},"references":{"sample-two":{"alt":"Screenshot of Xcode showing the marco expansion on a JSON enum with an optional String as return type","type":"image","identifier":"sample-two","variants":[{"url":"\/images\/sample-two@2x.png","traits":["2x","light"]},{"url":"\/images\/sample-two~dark@2x.png","traits":["2x","dark"]}]},"sample-three":{"alt":"Screenshot of Xcode showing the marco expansion on a Coordinate enum which uses multiple macros","type":"image","identifier":"sample-three","variants":[{"url":"\/images\/sample-three@2x.png","traits":["2x","light"]},{"url":"\/images\/sample-three~dark@2x.png","traits":["2x","dark"]}]},"doc://ExtractCaseValue/documentation/ExtractCaseValue":{"role":"collection","title":"ExtractCaseValue","abstract":[],"identifier":"doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue","kind":"symbol","type":"topic","url":"\/documentation\/extractcasevalue"},"fix-it":{"alt":"Screenshot of Xcode showing the fix-it","type":"image","identifier":"fix-it","variants":[{"url":"\/images\/fix-it@2x.png","traits":["2x","light"]},{"url":"\/images\/fix-it~dark@2x.png","traits":["2x","dark"]}]},"sample-one":{"alt":"Screenshot of Xcode showing the marco expansion on a Path enum with a String as return type","type":"image","identifier":"sample-one","variants":[{"url":"\/images\/sample-one@2x.png","traits":["2x","light"]},{"url":"\/images\/sample-one~dark@2x.png","traits":["2x","dark"]}]}}}

docs/data/documentation/extractcasevalue/extractcasevalue(name:kind:).json

@@ -0,0 +1 @@
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"attribute","text":"@attached"},{"kind":"text","text":"(member, names: arbitrary) "},{"kind":"keyword","text":"macro"},{"kind":"text","text":" "},{"kind":"identifier","text":"ExtractCaseValue"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":">("},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"kind"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CaseExtractionKind","preciseIdentifier":"s:22ExtractCaseValueMacros0B14ExtractionKindO"},{"kind":"text","text":" = .default) -> ()"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"For example"}]},{"type":"codeListing","syntax":"swift","code":["@ExtractCaseValue<String>(name: \"path\", kind: CaseExtractionKind.position(0))","enum Path {","  case relative(String)","  case absolute(String)","}"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"produces"}]},{"type":"codeListing","syntax":"swift","code":["enum Path {","  case relative(String)","  case absolute(String)","  case root","  var path: String {","    switch self {","    case let .relative(__macro_local_4pathfMu_):","      return __macro_local_4pathfMu_","    case let .absolute(__macro_local_4pathfMu0_):","      return __macro_local_4pathfMu0_","    }","  }","}"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/extractcasevalue\/extractcasevalue(name:kind:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue\/ExtractCaseValue(name:kind:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A macro that extracts an associated value from enum cases."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"macro"},{"kind":"text","text":" "},{"kind":"identifier","text":"ExtractCaseValue"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":">("},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"kind"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CaseExtractionKind","preciseIdentifier":"s:22ExtractCaseValueMacros0B14ExtractionKindO"},{"kind":"text","text":") -> ()"}],"title":"ExtractCaseValue(name:kind:)","roleHeading":"Macro","role":"symbol","symbolKind":"macro","externalID":"s:16ExtractCaseValueAA4name4kindySS_0abC6Macros0B14ExtractionKindOtclufm","modules":[{"name":"ExtractCaseValue"}]},"hierarchy":{"paths":[["doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue"]]},"references":{"doc://ExtractCaseValue/documentation/ExtractCaseValue/ExtractCaseValue(name:kind:)":{"role":"symbol","title":"ExtractCaseValue(name:kind:)","fragments":[{"kind":"keyword","text":"macro"},{"kind":"text","text":" "},{"kind":"identifier","text":"ExtractCaseValue"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":">("},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"kind"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CaseExtractionKind","preciseIdentifier":"s:22ExtractCaseValueMacros0B14ExtractionKindO"},{"kind":"text","text":") -> ()"}],"abstract":[{"type":"text","text":"A macro that extracts an associated value from enum cases."}],"identifier":"doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue\/ExtractCaseValue(name:kind:)","kind":"symbol","type":"topic","url":"\/documentation\/extractcasevalue\/extractcasevalue(name:kind:)"},"doc://ExtractCaseValue/documentation/ExtractCaseValue":{"role":"collection","title":"ExtractCaseValue","abstract":[],"identifier":"doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue","kind":"symbol","type":"topic","url":"\/documentation\/extractcasevalue"}}}

docs/data/documentation/extractcasevalue/extractcasevalue(name:kind:defaultvalue:).json

@@ -0,0 +1 @@
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"attribute","text":"@attached"},{"kind":"text","text":"(member, names: arbitrary) "},{"kind":"keyword","text":"macro"},{"kind":"text","text":" "},{"kind":"identifier","text":"ExtractCaseValue"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":">("},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"kind"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CaseExtractionKind","preciseIdentifier":"s:22ExtractCaseValueMacros0B14ExtractionKindO"},{"kind":"text","text":" = .default, "},{"kind":"externalParam","text":"defaultValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":") -> ()"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"For example"}]},{"type":"codeListing","syntax":"swift","code":["@ExtractCaseValue<String>(name: \"path\", kind: CaseExtractionKind.position(0), defaultValue: \"\")","enum Path {","  case relative(String)","  case absolute(String)","  case root","}"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"produces"}]},{"type":"codeListing","syntax":"swift","code":["enum Path {","  case relative(String)","  case absolute(String)","  case root","  var path: String {","    switch self {","    case let .relative(__macro_local_4pathfMu_):","      return __macro_local_4pathfMu_","    case let .absolute(__macro_local_4pathfMu0_):","      return __macro_local_4pathfMu0_","    case .root:","      return \"\"","    }","  }","}"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/extractcasevalue\/extractcasevalue(name:kind:defaultvalue:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue\/ExtractCaseValue(name:kind:defaultValue:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A macro that extracts an associated value from enum cases using a default value if"},{"type":"text","text":" "},{"type":"text","text":"extraction is not possible."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"macro"},{"kind":"text","text":" "},{"kind":"identifier","text":"ExtractCaseValue"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":">("},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"kind"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CaseExtractionKind","preciseIdentifier":"s:22ExtractCaseValueMacros0B14ExtractionKindO"},{"kind":"text","text":", "},{"kind":"externalParam","text":"defaultValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":") -> ()"}],"title":"ExtractCaseValue(name:kind:defaultValue:)","roleHeading":"Macro","role":"symbol","symbolKind":"macro","externalID":"s:16ExtractCaseValueAA4name4kind07defaultC0ySS_0abC6Macros0B14ExtractionKindOxtclufm","modules":[{"name":"ExtractCaseValue"}]},"hierarchy":{"paths":[["doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue"]]},"references":{"doc://ExtractCaseValue/documentation/ExtractCaseValue":{"role":"collection","title":"ExtractCaseValue","abstract":[],"identifier":"doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue","kind":"symbol","type":"topic","url":"\/documentation\/extractcasevalue"},"doc://ExtractCaseValue/documentation/ExtractCaseValue/ExtractCaseValue(name:kind:defaultValue:)":{"role":"symbol","title":"ExtractCaseValue(name:kind:defaultValue:)","fragments":[{"kind":"keyword","text":"macro"},{"kind":"text","text":" "},{"kind":"identifier","text":"ExtractCaseValue"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":">("},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"kind"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CaseExtractionKind","preciseIdentifier":"s:22ExtractCaseValueMacros0B14ExtractionKindO"},{"kind":"text","text":", "},{"kind":"externalParam","text":"defaultValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":") -> ()"}],"abstract":[{"type":"text","text":"A macro that extracts an associated value from enum cases using a default value if"},{"type":"text","text":" "},{"type":"text","text":"extraction is not possible."}],"identifier":"doc:\/\/ExtractCaseValue\/documentation\/ExtractCaseValue\/ExtractCaseValue(name:kind:defaultValue:)","kind":"symbol","type":"topic","url":"\/documentation\/extractcasevalue\/extractcasevalue(name:kind:defaultvalue:)"}}}