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.9 KiB
JSON
1 line
7.9 KiB
JSON
{"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharactersByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO2OkV"}],"modules":[{"name":"MarvelService"}],"roleHeading":"Instance Property","externalID":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO2okAG2OkVvp","symbolKind":"property","role":"symbol","title":"ok"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Output\/ok-swift.property"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Output"]]},"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcharactersbycomicid\/output\/ok-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO","text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Output"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO2OkV","text":"Ok","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Output\/Ok-swift.struct"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]},{"content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is not "},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}]}],"style":"note","name":"Throws"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}]}],"style":"note","name":"See Also"}],"kind":"content"}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByComicId/Output":{"title":"Operations.getCharactersByComicId.Output","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcharactersbycomicid\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Output","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByComicId/Output/ok-swift.property":{"title":"ok","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbycomicid\/output\/ok-swift.property","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Output\/ok-swift.property","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ok"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO","text":"getCharactersByComicId"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO","text":"Output"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByComicIdO6OutputO2OkV","text":"Ok"}]},"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/getCharactersByComicId":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbycomicid","title":"Operations.getCharactersByComicId","navigatorTitle":[{"text":"getCharactersByComicId","kind":"identifier"}],"type":"topic","abstract":[{"text":"Fetches lists of characters filtered by a comic id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByComicId"}]},"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/Operations/getCharactersByComicId/Output/Ok-swift.struct":{"title":"Operations.getCharactersByComicId.Output.Ok","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcharactersbycomicid\/output\/ok-swift.struct","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByComicId\/Output\/Ok-swift.struct","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}]}}} |