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
3.3 KiB
JSON

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"requestTimeout"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibscommunication\/httpresponsecode\/requesttimeout"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode\/requestTimeout","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"This response is sent on an idle connection by some servers, even without any previous request by the client. It means that the server would like to shut down this unused connection. This response is used much more since some browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing. Also note that some servers merely shut down the connection without sending this message."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"requestTimeout"}],"title":"HTTPResponseCode.requestTimeout","roleHeading":"Case","role":"symbol","symbolKind":"case","externalID":"s:22SwiftLibsCommunication16HTTPResponseCodeO14requestTimeoutyA2CmF","modules":[{"name":"SwiftLibsCommunication"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode"]]},"references":{"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/HTTPResponseCode/requestTimeout":{"role":"symbol","title":"HTTPResponseCode.requestTimeout","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"requestTimeout"}],"abstract":[{"type":"text","text":"This response is sent on an idle connection by some servers, even without any previous request by the client. It means that the server would like to shut down this unused connection. This response is used much more since some browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing. Also note that some servers merely shut down the connection without sending this message."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode\/requestTimeout","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication\/httpresponsecode\/requesttimeout"},"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"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication":{"role":"collection","title":"SwiftLibsCommunication","abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication"}}}