Javier Cicchelli
f7235cdd28
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>
1 line
3.7 KiB
JSON
1 line
3.7 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"serviceUnavailable"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibscommunication\/httpresponsecode\/serviceunavailable"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode\/serviceUnavailable","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This response should be used for temporary conditions and the Retry-After HTTP header should, if possible, contain the estimated time before the recovery of the service. The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"serviceUnavailable"}],"title":"HTTPResponseCode.serviceUnavailable","roleHeading":"Case","role":"symbol","symbolKind":"case","externalID":"s:22SwiftLibsCommunication16HTTPResponseCodeO18serviceUnavailableyA2CmF","modules":[{"name":"SwiftLibsCommunication"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode"]]},"references":{"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/HTTPResponseCode/serviceUnavailable":{"role":"symbol","title":"HTTPResponseCode.serviceUnavailable","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"serviceUnavailable"}],"abstract":[{"type":"text","text":"The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This response should be used for temporary conditions and the Retry-After HTTP header should, if possible, contain the estimated time before the recovery of the service. The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode\/serviceUnavailable","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication\/httpresponsecode\/serviceunavailable"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication":{"role":"collection","title":"SwiftLibsCommunication","abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication"}}} |