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
7.5 KiB
JSON
1 line
7.5 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"conflict"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","kind":"typeIdentifier","text":"getEvents"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO8ConflictV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/Conflict-swift.struct","kind":"typeIdentifier","text":"Conflict"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" }"}]}]},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"content":[{"inlineContent":[{"type":"text","text":"An error if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is not "},{"type":"codeVoice","code":".conflict"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","type":"aside","name":"Throws"},{"content":[{"inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":".conflict"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","type":"aside","name":"See Also"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"type":"text","text":" is "},{"type":"codeVoice","code":".conflict"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getevents\/output\/conflict-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"modules":[{"name":"MarvelService"}],"roleHeading":"Instance Property","title":"conflict","symbolKind":"property","externalID":"s:13MarvelService10OperationsO9getEventsO6OutputO8conflictAG8ConflictVvp","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"conflict"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","kind":"typeIdentifier","text":"getEvents"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO","kind":"typeIdentifier","text":"Output"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO8ConflictV","kind":"typeIdentifier","text":"Conflict"}]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/conflict-swift.property"},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getEvents/Output":{"url":"\/documentation\/marvelservice\/operations\/getevents\/output","title":"Operations.getEvents.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]},"doc://MarvelService/documentation/MarvelService/Operations":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/marvelservice\/operations","title":"Operations","role":"symbol","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"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/Operations/getEvents/Output/conflict-swift.property":{"url":"\/documentation\/marvelservice\/operations\/getevents\/output\/conflict-swift.property","title":"conflict","type":"topic","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".conflict"},{"type":"text","text":"."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/conflict-swift.property","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"conflict"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","kind":"typeIdentifier","text":"getEvents"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO8ConflictV","kind":"typeIdentifier","text":"Conflict"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEvents/Output/Conflict-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getevents\/output\/conflict-swift.struct","title":"Operations.getEvents.Output.Conflict","navigatorTitle":[{"kind":"identifier","text":"Conflict"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/Conflict-swift.struct","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Conflict"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEvents":{"url":"\/documentation\/marvelservice\/operations\/getevents","title":"Operations.getEvents","navigatorTitle":[{"kind":"identifier","text":"getEvents"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of events."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEvents"}]}}} |