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