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