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
4.8 KiB
JSON
1 line
4.8 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboClientError"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboclienterror"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/AmiiboService\/s5ErrorP","doc:\/\/AmiiboService\/s8SendableP"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError","interfaceLanguage":"swift"},"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."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboClientError"}],"title":"AmiiboClientError","roleHeading":"Enumeration","role":"symbol","symbolKind":"enum","externalID":"s:13AmiiboService0A11ClientErrorO","modules":[{"name":"AmiiboService"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboClientError"}]},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"topicSections":[{"title":"Enumeration Cases","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError\/responseCode(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError\/responseCodeNotFound"]},{"title":"Default Implementations","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError\/Error-Implementations"],"generated":true}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboClientError/responseCode(_:)":{"role":"symbol","title":"AmiiboClientError.responseCode(_:)","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"responseCode"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"The status code of the response is not the expected one, which is "},{"type":"codeVoice","code":".ok"},{"type":"text","text":" ("},{"type":"codeVoice","code":"200"},{"type":"text","text":")."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError\/responseCode(_:)","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiiboclienterror\/responsecode(_:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClientError/responseCodeNotFound":{"role":"symbol","title":"AmiiboClientError.responseCodeNotFound","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"responseCodeNotFound"}],"abstract":[{"type":"text","text":"The status code of the response was not received at all."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError\/responseCodeNotFound","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiiboclienterror\/responsecodenotfound"},"doc://AmiiboService/documentation/AmiiboService":{"role":"collection","title":"AmiiboService","abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/s5ErrorP":{"type":"unresolvable","title":"Swift.Error","identifier":"doc:\/\/AmiiboService\/s5ErrorP"},"doc://AmiiboService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/AmiiboService\/s8SendableP"},"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/Error-Implementations":{"role":"collectionGroup","title":"Error Implementations","abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError\/Error-Implementations","kind":"article","type":"topic","url":"\/documentation\/amiiboservice\/amiiboclienterror\/error-implementations"}}} |