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
12 KiB
JSON
1 line
12 KiB
JSON
{"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/MarvelService\/Se","doc:\/\/MarvelService\/SE","doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"sections":[],"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/textobject"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TextObject","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/TextObject"},{"type":"text","text":"."}]}],"style":"note","name":"Remark","type":"aside"}],"kind":"content"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"A type that represents bits of descriptive text which are attached to an entity."}],"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\/TextObject\/init(from:)"],"generated":true,"anchor":"Initializers"},{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/language","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/text"],"anchor":"Instance-Properties"},{"title":"Enumerations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys"],"generated":true,"anchor":"Enumerations"},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/Equatable-Implementations"]}],"seeAlsoSections":[{"anchor":"Common-Types","title":"Common Types","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDate","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicPrice","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Image","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url"],"generated":true}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"roleHeading":"Structure","title":"Components.Schemas.TextObject","modules":[{"name":"MarvelService"}],"symbolKind":"struct","navigatorTitle":[{"kind":"identifier","text":"TextObject"}],"externalID":"s:13MarvelService10ComponentsO7SchemasO10TextObjectV","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TextObject","kind":"identifier"}]},"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/TextObject/CodingKeys":{"title":"Components.Schemas.TextObject.CodingKeys","abstract":[],"url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"CodingKeys","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/TextObject/init(from:)":{"url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/init(from:)","title":"init(from:)","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}]},"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/ComicDate":{"title":"Components.Schemas.ComicDate","abstract":[{"text":"A type that represents a date and time for which the comic was released.","type":"text"}],"url":"\/documentation\/marvelservice\/components\/schemas\/comicdate","navigatorTitle":[{"text":"ComicDate","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDate","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ComicDate"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Url":{"abstract":[{"type":"text","text":"A type that represents a reference to web pages or deep links into applications. When present in a resultset, it is preferred that you use these to link back to Marvel. Many resources will have more than one representation on the web so URLs are generally presented as an array of URL resources."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url","navigatorTitle":[{"text":"Url","kind":"identifier"}],"title":"Components.Schemas.Url","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Url","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/url","type":"topic"},"doc://MarvelService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/TextObject/text":{"url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/text","title":"text","type":"topic","abstract":[{"type":"text","text":"The text of the text object."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/text","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"text","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/TextObject":{"title":"Components.Schemas.TextObject","abstract":[{"text":"A type that represents bits of descriptive text which are attached to an entity.","type":"text"}],"url":"\/documentation\/marvelservice\/components\/schemas\/textobject","navigatorTitle":[{"text":"TextObject","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TextObject","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/TextObject/Equatable-Implementations":{"title":"Equatable Implementations","abstract":[],"url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/equatable-implementations","kind":"article","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/Equatable-Implementations","type":"topic","role":"collectionGroup"},"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/Image":{"url":"\/documentation\/marvelservice\/components\/schemas\/image","title":"Components.Schemas.Image","navigatorTitle":[{"text":"Image","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that represents an image for a resource."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Image","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Image","kind":"identifier"}]},"doc://MarvelService/SE":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SE","title":"Swift.Encodable"},"doc://MarvelService/Se":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/Se","title":"Swift.Decodable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/TextObject/language":{"title":"language","abstract":[{"text":"The IETF language tag (or language code) denoting which language the text object is written in.","type":"text"}],"url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/language","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/language","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"language","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://MarvelService/SH":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicPrice":{"url":"\/documentation\/marvelservice\/components\/schemas\/comicprice","title":"Components.Schemas.ComicPrice","navigatorTitle":[{"kind":"identifier","text":"ComicPrice"}],"type":"topic","abstract":[{"text":"A type that represents a price (e.g. print price, digital price) for the comic.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicPrice","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ComicPrice"}]}}} |