eaee2b84f0
This PR contains the work done to update the overall documentation of the package. Reviewed-on: #17 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
6.0 KiB
JSON
1 line
6.0 KiB
JSON
{"sections":[],"abstract":[{"text":"Creates a new instance with the specified raw value.","type":"text"}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The raw value to use for the new instance."}],"type":"paragraph"}],"name":"rawValue"}]},{"content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"inlineContent":[{"type":"text","text":"If there is no value of the type that corresponds with the specified raw"},{"type":"text","text":" "},{"type":"text","text":"value, this initializer returns "},{"type":"codeVoice","code":"nil"},{"type":"text","text":". For example:"}],"type":"paragraph"},{"syntax":null,"type":"codeListing","code":["enum PaperSize: String {"," case A4, A5, Letter, Legal","}","","print(PaperSize(rawValue: \"Legal\"))","\/\/ Prints \"Optional(PaperSize.Legal)\"","","print(PaperSize(rawValue: \"Tabloid\"))","\/\/ Prints \"nil\""]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys\/init(rawValue:)"},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"roleHeading":"Initializer","modules":[{"name":"DiscogsService"}],"symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO12SearchResultV10CodingKeysO8rawValueAISgSS_tcfc","role":"symbol","title":"init(rawValue:)"},"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/searchresult\/codingkeys\/init(rawvalue:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Components"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/CodingKeys":{"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/codingkeys","kind":"symbol","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys","abstract":[],"type":"topic","title":"Components.Schemas.SearchResult.CodingKeys"},"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SearchResult"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult","type":"topic","role":"symbol","title":"Components.Schemas.SearchResult","abstract":[{"text":"A type that represents a search result.","type":"text"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"SearchResult"}],"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/CodingKeys/init(rawValue:)":{"title":"init(rawValue:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys\/init(rawValue:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Creates a new instance with the specified raw value."}],"kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/codingkeys\/init(rawvalue:)"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/schemas","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Schemas"}]}}} |