javier
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
4.8 KiB
JSON
1 line
4.8 KiB
JSON
{"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"roleHeading":"Instance Property","externalID":"s:13MarvelService10ComponentsO7SchemasO6SeriesV11descriptionSSvp","symbolKind":"property","modules":[{"name":"MarvelService"}],"role":"symbol","title":"description"},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"A description of the series.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Series"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/components\/schemas\/Series\/description","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note","type":"aside"}]}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Series\/description","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/series\/description"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"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/Series/description":{"title":"description","abstract":[{"type":"text","text":"A description of the series."}],"url":"\/documentation\/marvelservice\/components\/schemas\/series\/description","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Series\/description","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Series":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Series"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Series","navigatorTitle":[{"kind":"identifier","text":"Series"}],"url":"\/documentation\/marvelservice\/components\/schemas\/series","title":"Components.Schemas.Series","role":"symbol","abstract":[{"type":"text","text":"A series resource type that represents (usually) sequentially number list of comics with the same title and volume (e.g. Uncanny X-Men). Marvel uses the year of original publication for a series as the volume number."}],"type":"topic"},"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":{"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"}}} |