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