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
19 KiB
JSON
1 line
19 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EventDataWrapper","kind":"identifier"}]}]},{"content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/EventDataWrapper"},{"type":"text","text":"."}]}],"name":"Remark"}],"kind":"content"}],"topicSections":[{"generated":true,"anchor":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/init(code:status:copyright:attributionText:attributionHTML:data:etag:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/init(from:)"],"title":"Initializers"},{"generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/attributionHTML","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/attributionText","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/code","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/copyright","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/data","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/etag","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/status"],"title":"Instance Properties"},{"generated":true,"anchor":"Enumerations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/CodingKeys"],"title":"Enumerations"},{"generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/Equatable-Implementations"],"title":"Default Implementations"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"The wrapper for the event data."}],"relationshipsSections":[{"identifiers":["doc:\/\/MarvelService\/Se","doc:\/\/MarvelService\/SE","doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships","title":"Conforms To"}],"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"title":"Components.Schemas.EventDataWrapper","roleHeading":"Structure","modules":[{"name":"MarvelService"}],"symbolKind":"struct","navigatorTitle":[{"text":"EventDataWrapper","kind":"identifier"}],"externalID":"s:13MarvelService10ComponentsO7SchemasO16EventDataWrapperV","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EventDataWrapper","kind":"identifier"}]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper","interfaceLanguage":"swift"},"sections":[],"seeAlsoSections":[{"generated":true,"anchor":"Core-Entity-Wrappers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterDataWrapper","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataWrapper","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesDataWrapper","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper"],"title":"Core Entity Wrappers"}],"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataWrapper/CodingKeys":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/CodingKeys","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"title":"Components.Schemas.EventDataWrapper.CodingKeys","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper\/codingkeys"},"doc://MarvelService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/MarvelService\/SH"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataWrapper":{"url":"\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper","title":"Components.Schemas.EventDataWrapper","navigatorTitle":[{"kind":"identifier","text":"EventDataWrapper"}],"type":"topic","abstract":[{"text":"The wrapper for the event data.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"EventDataWrapper","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterDataWrapper":{"title":"Components.Schemas.CharacterDataWrapper","abstract":[{"type":"text","text":"The wrapper for the character data."}],"url":"\/documentation\/marvelservice\/components\/schemas\/characterdatawrapper","navigatorTitle":[{"kind":"identifier","text":"CharacterDataWrapper"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterDataWrapper","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CharacterDataWrapper"}]},"doc://MarvelService/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/MarvelService\/Se"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataWrapper/init(from:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/init(from:)","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper\/init(from:)","role":"symbol","abstract":[]},"doc://MarvelService/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/MarvelService\/SE"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataWrapper/init(code:status:copyright:attributionText:attributionHTML:data:etag:)":{"fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"status"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"copyright"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributionText"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributionHTML"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"data"},{"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:13MarvelService10ComponentsO7SchemasO18EventDataContainerV","kind":"typeIdentifier","text":"EventDataContainer"},{"kind":"text","text":", "},{"kind":"externalParam","text":"etag"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/init(code:status:copyright:attributionText:attributionHTML:data:etag:)","kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper\/init(code:status:copyright:attributiontext:attributionhtml:data:etag:)","title":"init(code:status:copyright:attributionText:attributionHTML:data:etag:)","role":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"EventDataWrapper"},{"type":"text","text":"."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataWrapper":{"abstract":[{"text":"The wrapper for the creator data.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper","navigatorTitle":[{"kind":"identifier","text":"CreatorDataWrapper"}],"title":"Components.Schemas.CreatorDataWrapper","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CreatorDataWrapper"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataWrapper/status":{"abstract":[{"text":"A string description of the call status.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/status","title":"status","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"status","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper\/status"},"doc://MarvelService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/MarvelService\/s8SendableP"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataWrapper/Equatable-Implementations":{"title":"Equatable Implementations","abstract":[],"url":"\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper\/equatable-implementations","kind":"article","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/Equatable-Implementations","type":"topic","role":"collectionGroup"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataWrapper":{"abstract":[{"type":"text","text":"The wrapper for the comic data."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataWrapper","navigatorTitle":[{"text":"ComicDataWrapper","kind":"identifier"}],"title":"Components.Schemas.ComicDataWrapper","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ComicDataWrapper","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/comicdatawrapper"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/SeriesDataWrapper":{"title":"Components.Schemas.SeriesDataWrapper","abstract":[{"type":"text","text":"The wrapper for the series data."}],"url":"\/documentation\/marvelservice\/components\/schemas\/seriesdatawrapper","navigatorTitle":[{"text":"SeriesDataWrapper","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesDataWrapper","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SeriesDataWrapper","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataWrapper/data":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/data","title":"data","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"data","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO18EventDataContainerV","text":"EventDataContainer","kind":"typeIdentifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper\/data","role":"symbol","abstract":[]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StoryDataWrapper":{"abstract":[{"type":"text","text":"The wrapper for the story data."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper","navigatorTitle":[{"text":"StoryDataWrapper","kind":"identifier"}],"title":"Components.Schemas.StoryDataWrapper","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"StoryDataWrapper","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/storydatawrapper","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/EventDataWrapper/attributionHTML":{"title":"attributionHTML","abstract":[{"type":"text","text":"An HTML representation of the attribution notice for this result. Please display either this notice or the contents of the attributionText field on all screens which contain data from the Marvel Comics API."}],"url":"\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper\/attributionhtml","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/attributionHTML","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"attributionHTML","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"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/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataWrapper/attributionText":{"title":"attributionText","abstract":[{"type":"text","text":"The attribution notice for this result. Please display either this notice or the contents of the attributionHTML field on all screens which contain data from the Marvel Comics API."}],"url":"\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper\/attributiontext","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/attributionText","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"attributionText","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"doc://MarvelService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/MarvelService\/SQ"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataWrapper/code":{"title":"code","abstract":[{"type":"text","text":"The HTTP status code of the returned result."}],"url":"\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper\/code","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/code","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}]},"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/EventDataWrapper/etag":{"url":"\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper\/etag","title":"etag","type":"topic","abstract":[{"text":"A digest value of the content returned by the call.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/etag","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"etag"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataWrapper/copyright":{"title":"copyright","abstract":[{"type":"text","text":"The copyright notice for the returned result."}],"url":"\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper\/copyright","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper\/copyright","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"copyright","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]}}} |