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
16 KiB
JSON
1 line
16 KiB
JSON
{"sections":[],"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/MarvelService\/Se","doc:\/\/MarvelService\/SE","doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"type":"conformsTo"}],"abstract":[{"text":"A resource list containing comics which feature this story.","type":"text"}],"seeAlsoSections":[{"title":"Core Entity List","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorList","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventList","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesList","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryList"],"generated":true,"anchor":"Core-Entity-List"}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"ComicList","kind":"identifier"}],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/components\/schemas\/ComicList","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note","type":"aside"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas"]]},"topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/init(available:returned:collectionURI:items:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/init(from:)"]},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/available","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/collectionURI","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/items","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/returned"],"generated":true,"title":"Instance Properties","anchor":"Instance-Properties"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/CodingKeys"],"generated":true,"title":"Enumerations","anchor":"Enumerations"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/Equatable-Implementations"],"generated":true,"title":"Default Implementations","anchor":"Default-Implementations"}],"metadata":{"title":"Components.Schemas.ComicList","externalID":"s:13MarvelService10ComponentsO7SchemasO9ComicListV","navigatorTitle":[{"text":"ComicList","kind":"identifier"}],"role":"symbol","roleHeading":"Structure","modules":[{"name":"MarvelService"}],"symbolKind":"struct","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ComicList","kind":"identifier"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/components\/schemas\/comiclist"]}],"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/SeriesList":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesList","title":"Components.Schemas.SeriesList","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SeriesList"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/serieslist","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"SeriesList"}],"abstract":[{"type":"text","text":"A resource list containing series in which this story appears."}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicList":{"abstract":[{"text":"A resource list containing comics which feature this story.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList","navigatorTitle":[{"text":"ComicList","kind":"identifier"}],"title":"Components.Schemas.ComicList","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ComicList","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/comiclist"},"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":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable"},"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/StoryList":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"StoryList","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryList","kind":"symbol","navigatorTitle":[{"text":"StoryList","kind":"identifier"}],"url":"\/documentation\/marvelservice\/components\/schemas\/storylist","title":"Components.Schemas.StoryList","role":"symbol","abstract":[{"type":"text","text":"A resource list containing stories which are related to this story."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicList/CodingKeys":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/CodingKeys","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"title":"Components.Schemas.ComicList.CodingKeys","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/comiclist\/codingkeys"},"doc://MarvelService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicList/collectionURI":{"abstract":[{"type":"text","text":"The path to the full list of issues in this collection."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/collectionURI","title":"collectionURI","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"collectionURI","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/comiclist\/collectionuri","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventList":{"abstract":[{"text":"A resource list containing events which feature this story.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventList","navigatorTitle":[{"kind":"identifier","text":"EventList"}],"title":"Components.Schemas.EventList","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"EventList"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/eventlist"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicList/returned":{"abstract":[{"text":"The number of issues returned in this collection.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/returned","title":"returned","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"returned","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/comiclist\/returned"},"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/ComicList/init(available:returned:collectionURI:items:)":{"url":"\/documentation\/marvelservice\/components\/schemas\/comiclist\/init(available:returned:collectionuri:items:)","title":"init(available:returned:collectionURI:items:)","type":"topic","abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"ComicList"},{"text":".","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/init(available:returned:collectionURI:items:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"available","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"returned","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"collectionURI","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"items","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"ComicSummary","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO12ComicSummaryV"},{"text":"])","kind":"text"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicList/items":{"url":"\/documentation\/marvelservice\/components\/schemas\/comiclist\/items","title":"items","type":"topic","abstract":[{"text":"The list of returned issues in this collection.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/items","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"items","kind":"identifier"},{"text":": [","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"ComicSummary","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO12ComicSummaryV"},{"text":"]","kind":"text"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicList/Equatable-Implementations":{"url":"\/documentation\/marvelservice\/components\/schemas\/comiclist\/equatable-implementations","title":"Equatable Implementations","type":"topic","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/Equatable-Implementations","kind":"article"},"doc://MarvelService/SE":{"identifier":"doc:\/\/MarvelService\/SE","title":"Swift.Encodable","type":"unresolvable"},"doc://MarvelService/Se":{"identifier":"doc:\/\/MarvelService\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorList":{"abstract":[{"text":"A resource list containing creators whose work appears in this story.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorList","navigatorTitle":[{"text":"CreatorList","kind":"identifier"}],"title":"Components.Schemas.CreatorList","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CreatorList","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/creatorlist","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterList":{"url":"\/documentation\/marvelservice\/components\/schemas\/characterlist","title":"Components.Schemas.CharacterList","navigatorTitle":[{"text":"CharacterList","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A resource list containing characters which appear in this story."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CharacterList","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicList/available":{"url":"\/documentation\/marvelservice\/components\/schemas\/comiclist\/available","title":"available","type":"topic","abstract":[{"type":"text","text":"The number of total available issues in this list. Will always be greater than or equal to the “returned” value."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/available","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"available","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicList/init(from:)":{"url":"\/documentation\/marvelservice\/components\/schemas\/comiclist\/init(from:)","title":"init(from:)","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList\/init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"doc://MarvelService/SH":{"identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable","type":"unresolvable"}}} |