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
File diff suppressed because one or more lines are too long
+1
@@ -0,0 +1 @@
|
||||
{"sections":[],"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/story\/codingkeys\/codingkey-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story\/CodingKeys\/debugDescription","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story\/CodingKeys\/description-swift.property"],"generated":true,"anchor":"Instance-Properties"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story\/CodingKeys"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story\/CodingKeys\/CodingKey-Implementations","interfaceLanguage":"swift"},"kind":"article","metadata":{"modules":[{"name":"MarvelService"}],"title":"CodingKey Implementations","roleHeading":"API Collection","role":"collectionGroup"},"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/Story":{"abstract":[{"type":"text","text":"A story resource type that represents an indivisible, reusable components of comics. Most comics have two stories - a cover and an interior story (e. g. the cover from Amazing Fantasy #15 and the origin of Spider-Man story from that comic) - but many, such as anthology comics and collections, will have more. Stories may be re-published in several comics, but the comic in which they originally appeared will always be present as a data point."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story","navigatorTitle":[{"kind":"identifier","text":"Story"}],"title":"Components.Schemas.Story","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Story"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/story","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Story/CodingKeys/description-swift.property":{"title":"description","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story\/CodingKeys\/description-swift.property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/story\/codingkeys\/description-swift.property","role":"symbol","abstract":[{"text":"A textual representation of this key.","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/Story/CodingKeys/debugDescription":{"title":"debugDescription","abstract":[{"type":"text","text":"A textual representation of this key, suitable for debugging."}],"url":"\/documentation\/marvelservice\/components\/schemas\/story\/codingkeys\/debugdescription","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story\/CodingKeys\/debugDescription","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Story/CodingKeys":{"url":"\/documentation\/marvelservice\/components\/schemas\/story\/codingkeys","title":"Components.Schemas.Story.CodingKeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story\/CodingKeys","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}]}}}
|
||||
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 @@
|
||||
{"sections":[],"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/story\/codingkeys\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"topicSections":[{"anchor":"Operators","title":"Operators","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story\/CodingKeys\/!=(_:_:)"],"generated":true}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story\/CodingKeys"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story\/CodingKeys\/Equatable-Implementations","interfaceLanguage":"swift"},"kind":"article","metadata":{"roleHeading":"API Collection","role":"collectionGroup","title":"Equatable Implementations","modules":[{"name":"MarvelService"}]},"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/Story/CodingKeys/!=(_:_:)":{"title":"!=(_:_:)","abstract":[{"text":"Returns a Boolean value indicating whether two values are not equal.","type":"text"}],"url":"\/documentation\/marvelservice\/components\/schemas\/story\/codingkeys\/!=(_:_:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story\/CodingKeys\/!=(_:_:)","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"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"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Story":{"abstract":[{"type":"text","text":"A story resource type that represents an indivisible, reusable components of comics. Most comics have two stories - a cover and an interior story (e. g. the cover from Amazing Fantasy #15 and the origin of Spider-Man story from that comic) - but many, such as anthology comics and collections, will have more. Stories may be re-published in several comics, but the comic in which they originally appeared will always be present as a data point."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story","navigatorTitle":[{"kind":"identifier","text":"Story"}],"title":"Components.Schemas.Story","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Story"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/story","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Story/CodingKeys":{"url":"\/documentation\/marvelservice\/components\/schemas\/story\/codingkeys","title":"Components.Schemas.Story.CodingKeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Story\/CodingKeys","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}]}}}
|
||||
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
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
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
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user