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:
File diff suppressed because one or more lines are too long
+1
@@ -0,0 +1 @@
|
||||
{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/components\/schemas\/url\/codingkeys\/codingkey-implementations"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys\/debugDescription","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys\/description"],"generated":true,"title":"Instance Properties","anchor":"Instance-Properties"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys\/CodingKey-Implementations","interfaceLanguage":"swift"},"kind":"article","metadata":{"modules":[{"name":"MarvelService"}],"roleHeading":"API Collection","title":"CodingKey Implementations","role":"collectionGroup"},"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/Components/Schemas/Url/CodingKeys/debugDescription":{"url":"\/documentation\/marvelservice\/components\/schemas\/url\/codingkeys\/debugdescription","title":"debugDescription","type":"topic","abstract":[{"type":"text","text":"A textual representation of this key, suitable for debugging."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys\/debugDescription","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Url/CodingKeys/description":{"title":"description","abstract":[{"type":"text","text":"A textual representation of this key."}],"url":"\/documentation\/marvelservice\/components\/schemas\/url\/codingkeys\/description","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys\/description","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"description"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Url/CodingKeys":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"title":"Components.Schemas.Url.CodingKeys","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/url\/codingkeys","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Url":{"abstract":[{"type":"text","text":"A type that represents a reference to web pages or deep links into applications. When present in a resultset, it is preferred that you use these to link back to Marvel. Many resources will have more than one representation on the web so URLs are generally presented as an array of URL resources."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url","navigatorTitle":[{"text":"Url","kind":"identifier"}],"title":"Components.Schemas.Url","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Url","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/url","type":"topic"}}}
|
||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+1
@@ -0,0 +1 @@
|
||||
{"sections":[],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys\/Equatable-Implementations","interfaceLanguage":"swift"},"kind":"article","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys"]]},"topicSections":[{"anchor":"Operators","title":"Operators","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys\/!=(_:_:)"],"generated":true}],"metadata":{"roleHeading":"API Collection","role":"collectionGroup","title":"Equatable Implementations","modules":[{"name":"MarvelService"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/url\/codingkeys\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"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/Components/Schemas/Url/CodingKeys/!=(_:_:)":{"abstract":[{"text":"Returns a Boolean value indicating whether two values are not equal.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys\/!=(_:_:)","title":"!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/url\/codingkeys\/!=(_:_:)"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Url":{"abstract":[{"type":"text","text":"A type that represents a reference to web pages or deep links into applications. When present in a resultset, it is preferred that you use these to link back to Marvel. Many resources will have more than one representation on the web so URLs are generally presented as an array of URL resources."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url","navigatorTitle":[{"text":"Url","kind":"identifier"}],"title":"Components.Schemas.Url","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Url","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/url","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Url/CodingKeys":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"title":"Components.Schemas.Url.CodingKeys","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/url\/codingkeys","type":"topic"}}}
|
||||
+1
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
@@ -0,0 +1 @@
|
||||
{"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys\/url","interfaceLanguage":"swift"},"metadata":{"symbolKind":"case","role":"symbol","externalID":"s:13MarvelService10ComponentsO7SchemasO3UrlV10CodingKeysO3urlyA2ImF","roleHeading":"Case","title":"Components.Schemas.Url.CodingKeys.url","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/components\/schemas\/url\/codingkeys\/url"]}],"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/Components/Schemas":{"navigatorTitle":[{"text":"Schemas","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas","url":"\/documentation\/marvelservice\/components\/schemas","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}],"role":"symbol","type":"topic","title":"Components.Schemas","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/schemas","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"kind":"symbol"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Url/CodingKeys/url":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys\/url","title":"Components.Schemas.Url.CodingKeys.url","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/url\/codingkeys\/url","role":"symbol","abstract":[]},"doc://MarvelService/documentation/MarvelService/Components":{"navigatorTitle":[{"text":"Components","kind":"identifier"}],"url":"\/documentation\/marvelservice\/components","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Components","kind":"identifier"}],"role":"symbol","type":"topic","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","kind":"symbol"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Url/CodingKeys":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url\/CodingKeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"title":"Components.Schemas.Url.CodingKeys","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/url\/codingkeys","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Url":{"abstract":[{"type":"text","text":"A type that represents a reference to web pages or deep links into applications. When present in a resultset, it is preferred that you use these to link back to Marvel. Many resources will have more than one representation on the web so URLs are generally presented as an array of URL resources."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Url","navigatorTitle":[{"text":"Url","kind":"identifier"}],"title":"Components.Schemas.Url","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Url","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/url","type":"topic"}}}
|
||||
Reference in New Issue
Block a user