Files
javier d5bd9feb0a First version of the library documentation (#7)
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>
2025-10-05 18:41:22 +00:00

1 line
5.7 KiB
JSON

{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"startYear"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":"?"}]}]},{"kind":"content","content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"name":"Remark","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/v1\/public\/characters\/{characterId}\/series\/GET\/query\/startYear","type":"codeVoice"},{"text":".","type":"text"}]}]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input\/Query-swift.struct"]]},"abstract":[{"text":"Return only series matching the specified start year.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/input\/query-swift.struct\/startyear"]}],"kind":"symbol","metadata":{"roleHeading":"Instance Property","modules":[{"name":"MarvelService"}],"title":"startYear","symbolKind":"property","externalID":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO5InputV5QueryV9startYearSiSgvp","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"startYear","kind":"identifier"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":"?","kind":"text"}]},"sections":[],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input\/Query-swift.struct\/startYear","interfaceLanguage":"swift"},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByCharacterId":{"url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid","title":"Operations.getSeriesByCharacterId","navigatorTitle":[{"kind":"identifier","text":"getSeriesByCharacterId"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of series filtered by a character id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getSeriesByCharacterId"}]},"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":{"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/getSeriesByCharacterId/Input/Query-swift.struct/startYear":{"title":"startYear","abstract":[{"text":"Return only series matching the specified start year.","type":"text"}],"url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/input\/query-swift.struct\/startyear","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input\/Query-swift.struct\/startYear","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"startYear","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":"?"}]},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByCharacterId/Input/Query-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/input\/query-swift.struct","title":"Operations.getSeriesByCharacterId.Input.Query","navigatorTitle":[{"kind":"identifier","text":"Query"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input\/Query-swift.struct","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}]},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByCharacterId/Input":{"url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/input","title":"Operations.getSeriesByCharacterId.Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}]}}}