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>
This commit was merged in pull request #7.
This commit is contained in:
@@ -0,0 +1 @@
|
||||
{"sections":[],"abstract":[{"type":"text","text":"Live service"}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Servers\/server1()","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"server1","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Servers"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/servers\/server1()"]}],"metadata":{"title":"server1()","modules":[{"name":"MarvelService"}],"platforms":[{"deprecated":true,"beta":false,"renamed":"Servers.Server1.url","unavailable":false}],"roleHeading":"Type Method","symbolKind":"method","externalID":"s:13MarvelService7ServersO7server110Foundation3URLVyKFZ","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"server1"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"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()":{"title":"server1()","abstract":[{"type":"text","text":"Live service"}],"url":"\/documentation\/marvelservice\/servers\/server1()","deprecated":true,"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Servers\/server1()","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"server1"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"}]},"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"}}}
|
||||
@@ -0,0 +1 @@
|
||||
{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}],"platforms":["macOS"]}],"kind":"declarations"}],"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Servers\/Server1\/url()"],"title":"Type Methods","generated":true,"anchor":"Type-Methods"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Servers"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Live service","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/servers\/server1"]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Servers\/Server1"},"metadata":{"modules":[{"name":"MarvelService"}],"title":"Servers.Server1","roleHeading":"Enumeration","symbolKind":"enum","navigatorTitle":[{"kind":"identifier","text":"Server1"}],"externalID":"s:13MarvelService7ServersO7Server1O","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}]},"sections":[],"seeAlsoSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware"],"title":"Configuration","generated":true,"anchor":"Configuration"}],"references":{"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"}]},"doc://MarvelService/documentation/MarvelService/AuthMiddleware":{"abstract":[{"text":"A middleware that attaches the necessary authentication parameters to the path of the request.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware","navigatorTitle":[{"text":"AuthMiddleware","kind":"identifier"}],"title":"AuthMiddleware","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMiddleware","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/authmiddleware"},"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/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"}]}}}
|
||||
@@ -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"}]}}}
|
||||
Reference in New Issue
Block a user