Javier Cicchelli a51fab18ba [Setup] DocC (#13)
This PR contains the work done to address the issue #11, related to setting up DocC documentation in this project.

To provide further details about the work done:
- [x] created the documentation catalog for the project in Xcode;
- [x] added the `Swift-DocC-Plugin` dependency to the `Package` file;
- [x] implemented documentation preview, generation and cleanup workflows in the `Makefile` file;
- [x] generated documentation for Xcode and Github pages;
- [x] added the package logo assets to the project;
- [x] integrated the package logo assets to the `README` file, with support for both light and dark color schemes;
- [x] added the `.env` file to the `.gitignore` file.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #13
2023-04-24 15:07:21 +00:00

1 line
2.7 KiB
JSON

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"timestamp"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/amiiboservice\/lastupdated\/timestamp"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/LastUpdated\/timestamp","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The date of the latest update of the remote API."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"timestamp"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}],"title":"timestamp","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:13AmiiboService11LastUpdatedV9timestamp10Foundation4DateVvp","modules":[{"name":"AmiiboService"}]},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/LastUpdated"]]},"references":{"doc://AmiiboService/documentation/AmiiboService/LastUpdated/timestamp":{"role":"symbol","title":"timestamp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"timestamp"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}],"abstract":[{"type":"text","text":"The date of the latest update of the remote API."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/LastUpdated\/timestamp","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/lastupdated\/timestamp"},"doc://AmiiboService/documentation/AmiiboService":{"role":"collection","title":"AmiiboService","abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/LastUpdated":{"role":"symbol","title":"LastUpdated","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"LastUpdated"}],"abstract":[{"type":"text","text":"This model represents the latest date when the remote API has been updated."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/LastUpdated","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"LastUpdated"}],"url":"\/documentation\/amiiboservice\/lastupdated"}}}