[Enhancement] DocC documentation support (#23)

This PR contains the work done to add DocC support to all the libraries included in this package, as requested by issue #9.

To provide further details about the work done:
- [x] added the DocC plugin package as a dependency
- [x] improved the naming of the targets in the Package file
- [x] updated the README file
- [x] implemented the Xcode and Github pages documentation generation targets in the Makefile file
- [x] generated both Xcode and Github pages documentation

Reviewed-on: https://repo.rock-n-code.com/rock-n-code/swift-libs/pulls/23
Co-authored-by: Javier Cicchelli <[email protected]>
Co-committed-by: Javier Cicchelli <[email protected]>

Documents/SwiftLibsCommunication.doccarchive/data/documentation/swiftlibscommunication.json

@@ -0,0 +1 @@
+{"variants":[{"paths":["\/documentation\/swiftlibscommunication"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","interfaceLanguage":"swift"},"topicSections":[{"title":"Classes","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLProtocol"]},{"title":"Protocols","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint"]},{"title":"Structures","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MakeURLRequestUseCase","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLResponse"]},{"title":"Enumerations","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPRequestMethod","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MakeURLRequestError"]}],"kind":"symbol","metadata":{"roleHeading":"Framework","externalID":"SwiftLibsCommunication","title":"SwiftLibsCommunication","symbolKind":"module","role":"collection","modules":[{"name":"SwiftLibsCommunication"}]},"hierarchy":{"paths":[[]]},"references":{"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Client":{"role":"symbol","title":"Client","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"abstract":[{"type":"text","text":"This protocol defines a client that will be making the remote calls."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Client"}],"url":"\/documentation\/swiftlibscommunication\/client"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MakeURLRequestError":{"role":"symbol","title":"MakeURLRequestError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"MakeURLRequestError"}],"abstract":[{"type":"text","text":"Errors generated out of the "},{"type":"codeVoice","code":"MakeURLRequestUseCase"},{"type":"text","text":" use case."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MakeURLRequestError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MakeURLRequestError"}],"url":"\/documentation\/swiftlibscommunication\/makeurlrequesterror"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint":{"role":"symbol","title":"Endpoint","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Endpoint"}],"abstract":[{"type":"text","text":"This protocol defines an endpoint to be used in a remote call."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Endpoint"}],"url":"\/documentation\/swiftlibscommunication\/endpoint"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLRequest":{"role":"symbol","title":"MockURLRequest","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLRequest"}],"abstract":[{"type":"text","text":"This model includes the data to be injected into an specific URL at the time of mocking its request."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLRequest"}],"url":"\/documentation\/swiftlibscommunication\/mockurlrequest"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MakeURLRequestUseCase":{"role":"symbol","title":"MakeURLRequestUseCase","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MakeURLRequestUseCase"}],"abstract":[{"type":"text","text":"This use case generate a url request out of a given endpoint."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MakeURLRequestUseCase","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MakeURLRequestUseCase"}],"url":"\/documentation\/swiftlibscommunication\/makeurlrequestusecase"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLProtocol":{"role":"symbol","title":"MockURLProtocol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLProtocol"}],"abstract":[{"type":"text","text":"This class overrides the "},{"type":"codeVoice","code":"URLProtocol"},{"type":"text","text":" protocol used by the "},{"type":"codeVoice","code":"URLSession"},{"type":"text","text":" to handle the loading of protocol-specific URL data so it is possible to mock URL response for testing purposes."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLProtocol","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLProtocol"}],"url":"\/documentation\/swiftlibscommunication\/mockurlprotocol"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/HTTPRequestMethod":{"role":"symbol","title":"HTTPRequestMethod","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"HTTPRequestMethod"}],"abstract":[{"type":"text","text":"Enumeration that represents the available HTTP request methods to use in this library."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPRequestMethod","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"HTTPRequestMethod"}],"url":"\/documentation\/swiftlibscommunication\/httprequestmethod"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication":{"role":"collection","title":"SwiftLibsCommunication","abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLResponse":{"role":"symbol","title":"MockURLResponse","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLResponse"}],"abstract":[{"type":"text","text":"This model includes the data to be injected into an specific URL at the time of mocking its response."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLResponse","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLResponse"}],"url":"\/documentation\/swiftlibscommunication\/mockurlresponse"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/HTTPResponseCode":{"role":"symbol","title":"HTTPResponseCode","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"HTTPResponseCode"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"HTTPResponseCode"}],"url":"\/documentation\/swiftlibscommunication\/httpresponsecode"}}}

Documents/SwiftLibsCommunication.doccarchive/data/documentation/swiftlibscommunication/client.json

@@ -0,0 +1 @@
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibscommunication\/client"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"This protocol defines a client that will be making the remote calls."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"title":"Client","roleHeading":"Protocol","role":"symbol","symbolKind":"protocol","externalID":"s:22SwiftLibsCommunication6ClientP","modules":[{"name":"SwiftLibsCommunication"}],"navigatorTitle":[{"kind":"identifier","text":"Client"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication"]]},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client\/request(endpoint:as:)"]}],"references":{"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Client":{"role":"symbol","title":"Client","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"abstract":[{"type":"text","text":"This protocol defines a client that will be making the remote calls."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Client"}],"url":"\/documentation\/swiftlibscommunication\/client"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Client/request(endpoint:as:)":{"role":"symbol","title":"request(endpoint:as:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"request"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"Model"},{"kind":"text","text":">("},{"kind":"externalParam","text":"endpoint"},{"kind":"text","text":": some "},{"kind":"typeIdentifier","text":"Endpoint","preciseIdentifier":"s:22SwiftLibsCommunication8EndpointP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"as"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Model"},{"kind":"text","text":".Type) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Model"}],"abstract":[{"type":"text","text":"Makes a request to a remote location based on a given endpoint and expects to return a response casted as a given model type."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client\/request(endpoint:as:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftlibscommunication\/client\/request(endpoint:as:)"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication":{"role":"collection","title":"SwiftLibsCommunication","abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication"}}}