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.5 KiB
JSON
1 line
6.5 KiB
JSON
{"sections":[],"abstract":[{"type":"text","text":"Encodes this value into the given encoder, when the type’s "},{"type":"codeVoice","code":"RawValue"},{"type":"text","text":" "},{"type":"text","text":"is "},{"type":"codeVoice","code":"String"},{"type":"text","text":"."}],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"encoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"text":"Encoder","preciseIdentifier":"s:s7EncoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"encoder","content":[{"type":"paragraph","inlineContent":[{"text":"The encoder to write data to.","type":"text"}]}]}]},{"content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"paragraph","inlineContent":[{"text":"This function throws an error if any values are invalid for the given","type":"text"},{"text":" ","type":"text"},{"text":"encoder’s format.","type":"text"}]}],"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\/Currency"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Currency\/encode(to:)"},"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"modules":[{"name":"DiscogsService","relatedModules":["Swift"]}],"roleHeading":"Instance Method","extendedModule":"Swift","symbolKind":"method","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"code":"Self","type":"codeVoice"},{"type":"text","text":" conforms to "},{"code":"Encodable","type":"codeVoice"},{"type":"text","text":" and "},{"code":"RawValue","type":"codeVoice"},{"type":"text","text":" is "},{"code":"String","type":"codeVoice"},{"type":"text","text":"."}]},"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"to"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7EncoderP","kind":"typeIdentifier","text":"Encoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"role":"symbol","externalID":"s:SYsSERzSS8RawValueSYRtzrlE6encode2toys7Encoder_p_tKF::SYNTHESIZED::s:14DiscogsService10ComponentsO7SchemasO8CurrencyO","title":"encode(to:)"},"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/currency\/encode(to:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"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/Currency":{"url":"\/documentation\/discogsservice\/components\/schemas\/currency","title":"Components.Schemas.Currency","navigatorTitle":[{"kind":"identifier","text":"Currency"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Currency"}],"abstract":[{"type":"text","text":"A list of currency codes defined in the marketplace."}],"kind":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Currency"},"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":{"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"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Currency/encode(to:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"to"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7EncoderP","kind":"typeIdentifier","text":"Encoder"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Encodable"},{"type":"text","text":" and "},{"type":"codeVoice","code":"RawValue"},{"type":"text","text":" is "},{"type":"codeVoice","code":"String"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"role":"symbol","type":"topic","title":"encode(to:)","kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/currency\/encode(to:)","abstract":[{"text":"Encodes this value into the given encoder, when the type’s ","type":"text"},{"code":"RawValue","type":"codeVoice"},{"text":" ","type":"text"},{"text":"is ","type":"text"},{"code":"String","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Currency\/encode(to:)"}}} |