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.2 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"preconditionRequired"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibscommunication\/httpresponsecode\/preconditionrequired"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode\/preconditionRequired","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The origin server requires the request to be conditional. This response is intended to prevent the lost update problem, where a client GETs a resources state, modifies it and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"preconditionRequired"}],"title":"HTTPResponseCode.preconditionRequired","roleHeading":"Case","role":"symbol","symbolKind":"case","externalID":"s:22SwiftLibsCommunication16HTTPResponseCodeO20preconditionRequiredyA2CmF","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/preconditionRequired":{"role":"symbol","title":"HTTPResponseCode.preconditionRequired","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"preconditionRequired"}],"abstract":[{"type":"text","text":"The origin server requires the request to be conditional. This response is intended to prevent the lost update problem, where a client GETs a resources state, modifies it and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPResponseCode\/preconditionRequired","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication\/httpresponsecode\/preconditionrequired"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication":{"role":"collection","title":"SwiftLibsCommunication","abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication"}}}