rock-n-code/marvel-service
1
0
Fork 0
Code Pull Requests Releases 2 Activity

First version of the library documentation (#7)

Browse Source 
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>
This commit was merged in pull request #7.
This commit is contained in:
Javier Cicchelli
2025-10-05 18:41:22 +00:00
committed by Javier Cicchelli
parent 178f59909f
commit d5bd9feb0a
14351 changed files with 14954 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/data/documentation/marvelservice/servers/server1/url().json
+1
View File
@@ -0,0 +1 @@
{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"platforms":["macOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Servers","doc:\/\/MarvelService\/documentation\/MarvelService\/Servers\/Server1"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Live service","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/servers\/server1\/url()"]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Servers\/Server1\/url()"},"metadata":{"title":"url()","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"externalID":"s:13MarvelService7ServersO7Server1O3url10Foundation3URLVyKFZ","roleHeading":"Type Method","role":"symbol","symbolKind":"method","modules":[{"name":"MarvelService"}]},"sections":[],"references":{"doc://MarvelService/documentation/MarvelService/Servers":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Servers","title":"Servers","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/servers","role":"symbol","navigatorTitle":[{"text":"Servers","kind":"identifier"}],"abstract":[{"text":"Server URLs defined in the OpenAPI document.","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Servers/Server1/url()":{"title":"url()","abstract":[{"text":"Live service","type":"text"}],"url":"\/documentation\/marvelservice\/servers\/server1\/url()","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Servers\/Server1\/url()","type":"topic","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}]},"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/Servers/Server1":{"title":"Servers.Server1","abstract":[{"text":"Live service","type":"text"}],"url":"\/documentation\/marvelservice\/servers\/server1","navigatorTitle":[{"text":"Server1","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Servers\/Server1","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}]}}}