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:
+1
File diff suppressed because one or more lines are too long
+1
@@ -0,0 +1 @@
|
||||
{"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys\/CodingKey-Implementations"},"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys\/debugDescription","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys\/description"],"generated":true,"anchor":"Instance-Properties","title":"Instance Properties"}],"metadata":{"title":"CodingKey Implementations","modules":[{"name":"MarvelService"}],"role":"collectionGroup","roleHeading":"API Collection"},"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"article","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys\/codingkey-implementations"]}],"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/TextObject/CodingKeys/debugDescription":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys\/debugDescription","title":"debugDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys\/debugdescription","role":"symbol","abstract":[{"text":"A textual representation of this key, suitable for debugging.","type":"text"}]},"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/TextObject/CodingKeys/description":{"abstract":[{"text":"A textual representation of this key.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys\/description","title":"description","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys\/description"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/TextObject":{"title":"Components.Schemas.TextObject","abstract":[{"text":"A type that represents bits of descriptive text which are attached to an entity.","type":"text"}],"url":"\/documentation\/marvelservice\/components\/schemas\/textobject","navigatorTitle":[{"text":"TextObject","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TextObject","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/TextObject/CodingKeys":{"title":"Components.Schemas.TextObject.CodingKeys","abstract":[],"url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"CodingKeys","kind":"identifier"}]}}}
|
||||
+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":[],"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys\/!=(_:_:)"],"title":"Operators","anchor":"Operators","generated":true}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys\/Equatable-Implementations"},"kind":"article","metadata":{"title":"Equatable Implementations","modules":[{"name":"MarvelService"}],"roleHeading":"API Collection","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/TextObject":{"title":"Components.Schemas.TextObject","abstract":[{"text":"A type that represents bits of descriptive text which are attached to an entity.","type":"text"}],"url":"\/documentation\/marvelservice\/components\/schemas\/textobject","navigatorTitle":[{"text":"TextObject","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TextObject","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/TextObject/CodingKeys":{"title":"Components.Schemas.TextObject.CodingKeys","abstract":[],"url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"CodingKeys","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/TextObject/CodingKeys/!=(_:_:)":{"url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys\/!=(_:_:)","title":"!=(_:_:)","type":"topic","abstract":[{"type":"text","text":"Returns a Boolean value indicating whether two values are not equal."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys\/!=(_:_:)","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}}}
|
||||
+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
+1
File diff suppressed because one or more lines are too long
+1
@@ -0,0 +1 @@
|
||||
{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"language","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys\/language"]}],"kind":"symbol","sections":[],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys\/language","interfaceLanguage":"swift"},"metadata":{"title":"Components.Schemas.TextObject.CodingKeys.language","externalID":"s:13MarvelService10ComponentsO7SchemasO10TextObjectV10CodingKeysO8languageyA2ImF","role":"symbol","modules":[{"name":"MarvelService"}],"roleHeading":"Case","symbolKind":"case","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"language"}]},"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/TextObject/CodingKeys":{"title":"Components.Schemas.TextObject.CodingKeys","abstract":[],"url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"CodingKeys","kind":"identifier"}]},"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":{"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/TextObject":{"title":"Components.Schemas.TextObject","abstract":[{"text":"A type that represents bits of descriptive text which are attached to an entity.","type":"text"}],"url":"\/documentation\/marvelservice\/components\/schemas\/textobject","navigatorTitle":[{"text":"TextObject","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TextObject","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/TextObject/CodingKeys/language":{"url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys\/language","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys\/language","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"language"}],"role":"symbol","type":"topic","abstract":[],"kind":"symbol","title":"Components.Schemas.TextObject.CodingKeys.language"}}}
|
||||
+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\/TextObject\/CodingKeys\/text","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"text","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys\/text"]}],"metadata":{"symbolKind":"case","role":"symbol","externalID":"s:13MarvelService10ComponentsO7SchemasO10TextObjectV10CodingKeysO4textyA2ImF","title":"Components.Schemas.TextObject.CodingKeys.text","roleHeading":"Case","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"text","kind":"identifier"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"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/TextObject/CodingKeys":{"title":"Components.Schemas.TextObject.CodingKeys","abstract":[],"url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"CodingKeys","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/TextObject/CodingKeys/text":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject\/CodingKeys\/text","title":"Components.Schemas.TextObject.CodingKeys.text","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"text","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/textobject\/codingkeys\/text"},"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":{"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/TextObject":{"title":"Components.Schemas.TextObject","abstract":[{"text":"A type that represents bits of descriptive text which are attached to an entity.","type":"text"}],"url":"\/documentation\/marvelservice\/components\/schemas\/textobject","navigatorTitle":[{"text":"TextObject","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/TextObject","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TextObject","kind":"identifier"}]}}}
|
||||
Reference in New Issue
Block a user