Javier Cicchelli
a51fab18ba
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
1 line
2.3 KiB
JSON
1 line
2.3 KiB
JSON
{"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboclienterror\/error-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError\/Error-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError\/localizedDescription"],"generated":true}],"kind":"article","metadata":{"modules":[{"name":"AmiiboService"}],"role":"collectionGroup","title":"Error Implementations"},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError"]]},"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboClientError":{"role":"symbol","title":"AmiiboClientError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboClientError"}],"abstract":[{"type":"text","text":"This error definitions represents any error happening while the client makes a request to the remote API and handles the respective response, excluding the decoding of the retrieved data into a particular model."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboClientError"}],"url":"\/documentation\/amiiboservice\/amiiboclienterror"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClientError/localizedDescription":{"role":"symbol","title":"localizedDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError\/localizedDescription","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiiboclienterror\/localizeddescription"},"doc://AmiiboService/documentation/AmiiboService":{"role":"collection","title":"AmiiboService","abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice"}}} |