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