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
{"relationshipsSections":[{"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"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/count","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/limit","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/offset","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/results","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/total"],"generated":true,"title":"Enumeration Cases","anchor":"Enumeration-Cases"},{"title":"Initializers","anchor":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/init(intValue:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/init(rawValue:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/init(stringValue:)"],"generated":true},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/CodingKey-Implementations","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/Equatable-Implementations","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/RawRepresentable-Implementations"],"generated":true,"title":"Default Implementations","anchor":"Default-Implementations"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"title":"Components.Schemas.CreatorDataContainer.CodingKeys","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"externalID":"s:13MarvelService10ComponentsO7SchemasO20CreatorDataContainerV10CodingKeysO","roleHeading":"Enumeration","role":"symbol","symbolKind":"enum","modules":[{"name":"MarvelService"}],"navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}]},"references":{"doc://MarvelService/s9CodingKeyP":{"type":"unresolvable","title":"Swift.CodingKey","identifier":"doc:\/\/MarvelService\/s9CodingKeyP"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/CodingKeys/RawRepresentable-Implementations":{"abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/RawRepresentable-Implementations","title":"RawRepresentable Implementations","kind":"article","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys\/rawrepresentable-implementations","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/CodingKeys/count":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys\/count","title":"Components.Schemas.CreatorDataContainer.CodingKeys.count","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/count","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"count","kind":"identifier"}]},"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"},"doc://MarvelService/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/MarvelService\/SQ","type":"unresolvable"},"doc://MarvelService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable"},"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/documentation/MarvelService/Components/Schemas/CreatorDataContainer/CodingKeys":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys","title":"Components.Schemas.CreatorDataContainer.CodingKeys","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}]},"doc://MarvelService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/CodingKeys/init(rawValue:)":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys\/init(rawvalue:)","title":"init(rawValue:)","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/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/CreatorDataContainer/CodingKeys/results":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys\/results","title":"Components.Schemas.CreatorDataContainer.CodingKeys.results","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/results","kind":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"results"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/CodingKeys/Equatable-Implementations":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/Equatable-Implementations","title":"Equatable Implementations","kind":"article","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys\/equatable-implementations","role":"collectionGroup","abstract":[]},"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/Schemas/CreatorDataContainer":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer","title":"Components.Schemas.CreatorDataContainer","navigatorTitle":[{"text":"CreatorDataContainer","kind":"identifier"}],"type":"topic","abstract":[{"text":"A container type for lists of creators.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CreatorDataContainer","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/CodingKeys/limit":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/limit","title":"Components.Schemas.CreatorDataContainer.CodingKeys.limit","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"limit"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys\/limit","type":"topic"},"doc://MarvelService/s23CustomStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s23CustomStringConvertibleP","title":"Swift.CustomStringConvertible"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/CodingKeys/total":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/total","title":"Components.Schemas.CreatorDataContainer.CodingKeys.total","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"total"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys\/total","role":"symbol","abstract":[]},"doc://MarvelService/SY":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SY","title":"Swift.RawRepresentable"},"doc://MarvelService/s28CustomDebugStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/CodingKeys/init(stringValue:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/init(stringValue:)","title":"init(stringValue:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"stringValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys\/init(stringvalue:)","role":"symbol","abstract":[]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/CodingKeys/offset":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/offset","title":"Components.Schemas.CreatorDataContainer.CodingKeys.offset","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"offset"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys\/offset","role":"symbol","abstract":[]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/CodingKeys/init(intValue:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/init(intValue:)","title":"init(intValue:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"intValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":")"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys\/init(intvalue:)","role":"symbol","abstract":[]},"doc://MarvelService/SH":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/CodingKeys/CodingKey-Implementations":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys\/CodingKey-Implementations","title":"CodingKey Implementations","kind":"article","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys\/codingkey-implementations","role":"collectionGroup","abstract":[]}}} |