Javier Cicchelli f7235cdd28 [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: #23
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2023-08-13 22:01:00 +00:00

1 line
2.9 KiB
JSON

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"override"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"stopLoading"},{"kind":"text","text":"()"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibscommunication\/mockurlprotocol\/stoploading()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLProtocol\/stopLoading()","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"stopLoading"},{"kind":"text","text":"()"}],"title":"stopLoading()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"c:@M@SwiftLibsCommunication@objc(cs)MockURLProtocol(im)stopLoading","modules":[{"name":"SwiftLibsCommunication"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLProtocol"]]},"references":{"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLProtocol/stopLoading()":{"role":"symbol","title":"stopLoading()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"stopLoading"},{"kind":"text","text":"()"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLProtocol\/stopLoading()","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication\/mockurlprotocol\/stoploading()"},"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/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"}}}