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
17 KiB
JSON
1 line
17 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":[{"type":"text","text":"The container for the event data."}],"seeAlsoSections":[{"title":"Core Entity Containers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterDataContainer","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesDataContainer","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataContainer"],"generated":true,"anchor":"Core-Entity-Containers"}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EventDataContainer","kind":"identifier"}]}]},{"content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/EventDataContainer"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Remark"}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/init(from:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/init(offset:limit:total:count:results:)"],"generated":true,"anchor":"Initializers"},{"title":"Instance Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/count","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/limit","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/offset","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/results","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/total"],"generated":true,"anchor":"Instance-Properties"},{"title":"Enumerations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/CodingKeys"],"generated":true,"anchor":"Enumerations"},{"title":"Default Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"metadata":{"title":"Components.Schemas.EventDataContainer","externalID":"s:13MarvelService10ComponentsO7SchemasO18EventDataContainerV","navigatorTitle":[{"text":"EventDataContainer","kind":"identifier"}],"role":"symbol","modules":[{"name":"MarvelService"}],"symbolKind":"struct","roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EventDataContainer","kind":"identifier"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/eventdatacontainer"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataContainer/init(offset:limit:total:count:results:)":{"abstract":[{"text":"Creates a new ","type":"text"},{"code":"EventDataContainer","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/init(offset:limit:total:count:results:)","title":"init(offset:limit:total:count:results:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"offset"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"limit"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"total"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"count"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"results"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:13MarvelService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO5EventV","kind":"typeIdentifier","text":"Event"},{"kind":"text","text":"])"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatacontainer\/init(offset:limit:total:count:results:)","type":"topic"},"doc://MarvelService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataContainer/offset":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"offset","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/offset","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatacontainer\/offset","title":"offset","role":"symbol","abstract":[{"text":"The requested offset (number of skipped results) of the call.","type":"text"}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataContainer/total":{"abstract":[{"text":"The total number of resources available given the current filter set.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/total","title":"total","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"total","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatacontainer\/total"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataContainer/CodingKeys":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/CodingKeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"title":"Components.Schemas.EventDataContainer.CodingKeys","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatacontainer\/codingkeys"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataContainer/limit":{"abstract":[{"text":"The requested result limit.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/limit","title":"limit","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"limit","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatacontainer\/limit"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataContainer/Equatable-Implementations":{"abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/Equatable-Implementations","title":"Equatable Implementations","kind":"article","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatacontainer\/equatable-implementations"},"doc://MarvelService/SE":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SE","title":"Swift.Encodable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataContainer/results":{"abstract":[{"text":"The list of events returned by the call","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/results","title":"results","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"results","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":"Event","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO5EventV"},{"text":"]","kind":"text"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatacontainer\/results","type":"topic"},"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/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/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":{"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/SeriesDataContainer":{"url":"\/documentation\/marvelservice\/components\/schemas\/seriesdatacontainer","title":"Components.Schemas.SeriesDataContainer","navigatorTitle":[{"kind":"identifier","text":"SeriesDataContainer"}],"type":"topic","abstract":[{"text":"The container for the series data.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesDataContainer","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SeriesDataContainer"}]},"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":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable"},"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/Se":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/Se","title":"Swift.Decodable"},"doc://MarvelService/SQ":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable"},"doc://MarvelService/SH":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataContainer":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer","title":"Components.Schemas.EventDataContainer","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EventDataContainer","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatacontainer","role":"symbol","navigatorTitle":[{"text":"EventDataContainer","kind":"identifier"}],"abstract":[{"text":"The container for the event data.","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataContainer/init(from:)":{"url":"\/documentation\/marvelservice\/components\/schemas\/eventdatacontainer\/init(from:)","title":"init(from:)","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/init(from:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterDataContainer":{"abstract":[{"text":"The container for the character data.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterDataContainer","navigatorTitle":[{"kind":"identifier","text":"CharacterDataContainer"}],"title":"Components.Schemas.CharacterDataContainer","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CharacterDataContainer","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/characterdatacontainer"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataContainer/count":{"abstract":[{"text":"The total number of results returned by this call.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer\/count","title":"count","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"count","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatacontainer\/count"}}} |