d5bd9feb0a
This PR contains the work done to write the main article of the `DocC` documentation for the library, which introduces the library as well as explains how to install it and use it. Reviewed-on: #7 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
14 KiB
JSON
1 line
14 KiB
JSON
{"sections":[],"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/MarvelService\/s9CodingKeyP","doc:\/\/MarvelService\/s28CustomDebugStringConvertibleP","doc:\/\/MarvelService\/s23CustomStringConvertibleP","doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/SY","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"type":"conformsTo"}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer"]]},"topicSections":[{"generated":true,"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/count","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/limit","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/offset","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/results","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/total"],"title":"Enumeration Cases","anchor":"Enumeration-Cases"},{"generated":true,"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/init(intValue:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/init(rawValue:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/init(stringValue:)"],"title":"Initializers","anchor":"Initializers"},{"generated":true,"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/CodingKey-Implementations","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/Equatable-Implementations","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/RawRepresentable-Implementations"],"title":"Default Implementations","anchor":"Default-Implementations"}],"metadata":{"title":"Components.Schemas.ComicDataContainer.CodingKeys","externalID":"s:13MarvelService10ComponentsO7SchemasO18ComicDataContainerV10CodingKeysO","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"role":"symbol","modules":[{"name":"MarvelService"}],"roleHeading":"Enumeration","symbolKind":"enum","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer\/codingkeys"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer/CodingKeys/init(stringValue:)":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/init(stringValue:)","title":"init(stringValue:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"stringValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer\/codingkeys\/init(stringvalue:)","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer/CodingKeys/CodingKey-Implementations":{"abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/CodingKey-Implementations","title":"CodingKey Implementations","kind":"article","url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer\/codingkeys\/codingkey-implementations","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer/CodingKeys/Equatable-Implementations":{"abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/Equatable-Implementations","title":"Equatable Implementations","kind":"article","url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer\/codingkeys\/equatable-implementations","type":"topic"},"doc://MarvelService/s16SendableMetatypeP":{"identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer/CodingKeys":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"title":"Components.Schemas.ComicDataContainer.CodingKeys","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer\/codingkeys"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer/CodingKeys/init(intValue:)":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/init(intValue:)","title":"init(intValue:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"intValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer\/codingkeys\/init(intvalue:)"},"doc://MarvelService/documentation/MarvelService/Components/Schemas":{"navigatorTitle":[{"text":"Schemas","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas","url":"\/documentation\/marvelservice\/components\/schemas","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}],"role":"symbol","type":"topic","title":"Components.Schemas","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/schemas","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"kind":"symbol"},"doc://MarvelService/documentation/MarvelService/Components":{"navigatorTitle":[{"text":"Components","kind":"identifier"}],"url":"\/documentation\/marvelservice\/components","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Components","kind":"identifier"}],"role":"symbol","type":"topic","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","kind":"symbol"},"doc://MarvelService/s8SendableP":{"identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://MarvelService/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/MarvelService\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible","type":"unresolvable"},"doc://MarvelService/SH":{"identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable","type":"unresolvable"},"doc://MarvelService/SY":{"identifier":"doc:\/\/MarvelService\/SY","title":"Swift.RawRepresentable","type":"unresolvable"},"doc://MarvelService/s9CodingKeyP":{"identifier":"doc:\/\/MarvelService\/s9CodingKeyP","title":"Swift.CodingKey","type":"unresolvable"},"doc://MarvelService/s23CustomStringConvertibleP":{"identifier":"doc:\/\/MarvelService\/s23CustomStringConvertibleP","title":"Swift.CustomStringConvertible","type":"unresolvable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer/CodingKeys/offset":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/offset","title":"Components.Schemas.ComicDataContainer.CodingKeys.offset","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"offset","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer\/codingkeys\/offset","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer/CodingKeys/RawRepresentable-Implementations":{"abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/RawRepresentable-Implementations","title":"RawRepresentable Implementations","kind":"article","url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer\/codingkeys\/rawrepresentable-implementations","type":"topic"},"doc://MarvelService/SQ":{"identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer/CodingKeys/results":{"url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer\/codingkeys\/results","title":"Components.Schemas.ComicDataContainer.CodingKeys.results","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/results","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"results","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer/CodingKeys/total":{"url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer\/codingkeys\/total","title":"Components.Schemas.ComicDataContainer.CodingKeys.total","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/total","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"total","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer/CodingKeys/limit":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/limit","title":"Components.Schemas.ComicDataContainer.CodingKeys.limit","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"limit"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer\/codingkeys\/limit"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer/CodingKeys/init(rawValue:)":{"url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer\/codingkeys\/init(rawvalue:)","title":"init(rawValue:)","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/init(rawValue:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer":{"url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer","title":"Components.Schemas.ComicDataContainer","navigatorTitle":[{"text":"ComicDataContainer","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"The container for the comic data."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ComicDataContainer","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer/CodingKeys/count":{"title":"Components.Schemas.ComicDataContainer.CodingKeys.count","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer\/CodingKeys\/count","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"count"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer\/codingkeys\/count","role":"symbol","abstract":[]},"doc://MarvelService/documentation/MarvelService":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","kind":"symbol","url":"\/documentation\/marvelservice","title":"MarvelService","role":"collection","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"type":"text","text":" backend service."}],"type":"topic"}}} |