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
18 KiB
JSON
1 line
18 KiB
JSON
{"interfaceLanguages":{"swift":[{"children":[{"title":"Classes","type":"groupMarker"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/mockurlprotocol\/startloading()","title":"func startLoading()","type":"method"},{"path":"\/documentation\/swiftlibscommunication\/mockurlprotocol\/stoploading()","title":"func stopLoading()","type":"method"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/mockurlprotocol\/mockdata","title":"static var mockData: [MockURLRequest : MockURLResponse]","type":"property"},{"title":"Type Methods","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/mockurlprotocol\/caninit(with:)-3oxns","title":"class func canInit(with: URLRequest) -> Bool","type":"method"},{"path":"\/documentation\/swiftlibscommunication\/mockurlprotocol\/caninit(with:)-8nlgj","title":"class func canInit(with: URLSessionTask) -> Bool","type":"method"},{"path":"\/documentation\/swiftlibscommunication\/mockurlprotocol\/canonicalrequest(for:)","title":"class func canonicalRequest(for: URLRequest) -> URLRequest","type":"method"}],"path":"\/documentation\/swiftlibscommunication\/mockurlprotocol","title":"MockURLProtocol","type":"class"},{"title":"Protocols","type":"groupMarker"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/client\/request(endpoint:as:)","title":"func request<Model>(endpoint: some Endpoint, as: Model.Type) async throws -> Model","type":"method"}],"path":"\/documentation\/swiftlibscommunication\/client","title":"Client","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/endpoint\/body","title":"var body: Data?","type":"property"},{"path":"\/documentation\/swiftlibscommunication\/endpoint\/headers-swift.property","title":"var headers: Self.Headers","type":"property"},{"path":"\/documentation\/swiftlibscommunication\/endpoint\/host","title":"var host: String","type":"property"},{"path":"\/documentation\/swiftlibscommunication\/endpoint\/method","title":"var method: HTTPRequestMethod","type":"property"},{"path":"\/documentation\/swiftlibscommunication\/endpoint\/parameters-swift.property","title":"var parameters: Self.Parameters","type":"property"},{"path":"\/documentation\/swiftlibscommunication\/endpoint\/path","title":"var path: String","type":"property"},{"path":"\/documentation\/swiftlibscommunication\/endpoint\/port","title":"var port: Int?","type":"property"},{"path":"\/documentation\/swiftlibscommunication\/endpoint\/scheme","title":"var scheme: String","type":"property"},{"title":"Type Aliases","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/endpoint\/headers-swift.typealias","title":"Endpoint.Headers","type":"typealias"},{"path":"\/documentation\/swiftlibscommunication\/endpoint\/parameters-swift.typealias","title":"Endpoint.Parameters","type":"typealias"}],"path":"\/documentation\/swiftlibscommunication\/endpoint","title":"Endpoint","type":"protocol"},{"title":"Structures","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/makeurlrequestusecase\/init()","title":"init()","type":"init"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/makeurlrequestusecase\/callasfunction(endpoint:)","title":"func callAsFunction(endpoint: some Endpoint) throws -> URLRequest","type":"method"}],"path":"\/documentation\/swiftlibscommunication\/makeurlrequestusecase","title":"MakeURLRequestUseCase","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/mockurlrequest\/init(method:url:)","title":"init(method: HTTPRequestMethod, url: URL)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/mockurlrequest\/method","title":"let method: HTTPRequestMethod","type":"property"},{"path":"\/documentation\/swiftlibscommunication\/mockurlrequest\/url","title":"let url: URL","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/mockurlrequest\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/swiftlibscommunication\/mockurlrequest\/equatable-implementations","title":"Equatable Implementations","type":"symbol"}],"path":"\/documentation\/swiftlibscommunication\/mockurlrequest","title":"MockURLRequest","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/mockurlresponse\/init(status:headers:data:)","title":"init(status: HTTPResponseCode, headers: [String : String], data: Data?)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/mockurlresponse\/data","title":"let data: Data?","type":"property"},{"path":"\/documentation\/swiftlibscommunication\/mockurlresponse\/headers","title":"let headers: [String : String]","type":"property"},{"path":"\/documentation\/swiftlibscommunication\/mockurlresponse\/status","title":"let status: HTTPResponseCode","type":"property"}],"path":"\/documentation\/swiftlibscommunication\/mockurlresponse","title":"MockURLResponse","type":"struct"},{"title":"Enumerations","type":"groupMarker"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/connect","title":"case connect","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/delete","title":"case delete","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/get","title":"case get","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/head","title":"case head","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/options","title":"case options","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/patch","title":"case patch","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/post","title":"case post","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/put","title":"case put","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/trace","title":"case trace","type":"case"},{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/init(rawvalue:)","title":"init?(rawValue: String)","type":"init"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/hashvalue","title":"var hashValue: Int","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/hash(into:)","title":"func hash(into: inout Hasher)","type":"method"}],"path":"\/documentation\/swiftlibscommunication\/httprequestmethod\/rawrepresentable-implementations","title":"RawRepresentable Implementations","type":"symbol"}],"path":"\/documentation\/swiftlibscommunication\/httprequestmethod","title":"HTTPRequestMethod","type":"enum"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/accepted","title":"case accepted","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/alreadyreported","title":"case alreadyReported","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/badgateway","title":"case badGateway","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/badrequest","title":"case badRequest","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/conflict","title":"case conflict","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/continue","title":"case `continue`","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/created","title":"case created","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/earlyhints","title":"case earlyHints","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/expectationfailed","title":"case expectationFailed","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/faileddependency","title":"case failedDependency","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/forbidden","title":"case forbidden","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/found","title":"case found","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/gatewaytimeout","title":"case gatewayTimeout","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/gone","title":"case gone","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/httpversionnotsupported","title":"case httpVersionNotSupported","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/imateapot","title":"case imATeapot","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/imused","title":"case imUsed","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/insufficientstorage","title":"case insufficientStorage","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/internalservererror","title":"case internalServerError","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/lengthrequired","title":"case lengthRequired","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/locked","title":"case locked","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/loopdetected","title":"case loopDetected","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/methodnotallowed","title":"case methodNotAllowed","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/misdirectedrequest","title":"case misdirectedRequest","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/movedpermanetly","title":"case movedPermanetly","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/multistatus","title":"case multiStatus","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/multiplechoices","title":"case multipleChoices","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/networkauthenticationrequired","title":"case networkAuthenticationRequired","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/nocontent","title":"case noContent","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/nonauthoritativeinformation","title":"case nonAuthoritativeInformation","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/notacceptable","title":"case notAcceptable","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/notextended","title":"case notExtended","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/notfound","title":"case notFound","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/notimplemented","title":"case notImplemented","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/notmodified","title":"case notModified","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/ok","title":"case ok","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/partialcontent","title":"case partialContent","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/payloadtoolarge","title":"case payloadTooLarge","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/paymentrequired","title":"case paymentRequired","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/permanentredirect","title":"case permanentRedirect","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/preconditionfailed","title":"case preconditionFailed","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/preconditionrequired","title":"case preconditionRequired","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/processing","title":"case processing","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/proxyauthenticationrequired","title":"case proxyAuthenticationRequired","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/rangenotsatisfiable","title":"case rangeNotSatisfiable","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/requestheaderfieldstoolarge","title":"case requestHeaderFieldsTooLarge","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/requesttimeout","title":"case requestTimeout","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/resetcontent","title":"case resetContent","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/seeother","title":"case seeOther","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/serviceunavailable","title":"case serviceUnavailable","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/switchingprotocols","title":"case switchingProtocols","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/temporaryredirect","title":"case temporaryRedirect","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/tooearly","title":"case tooEarly","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/toomanyrequests","title":"case tooManyRequests","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/unauthorized","title":"case unauthorized","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/unavailableforlegalreasons","title":"case unavailableForLegalReasons","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/unprocessablecontent","title":"case unprocessableContent","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/unsupportedmediatype","title":"case unsupportedMediaType","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/unused","title":"case unused","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/upgraderequired","title":"case upgradeRequired","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/uritoolong","title":"case uriTooLong","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/useproxy","title":"case useProxy","type":"case"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/variantalsonegotiates","title":"case variantAlsoNegotiates","type":"case"},{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/init(rawvalue:)","title":"init?(rawValue: Int)","type":"init"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/hashvalue","title":"var hashValue: Int","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/hash(into:)","title":"func hash(into: inout Hasher)","type":"method"}],"path":"\/documentation\/swiftlibscommunication\/httpresponsecode\/rawrepresentable-implementations","title":"RawRepresentable Implementations","type":"symbol"}],"path":"\/documentation\/swiftlibscommunication\/httpresponsecode","title":"HTTPResponseCode","type":"enum"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/makeurlrequesterror\/urlnotcreated","title":"case urlNotCreated","type":"case"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/makeurlrequesterror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/swiftlibscommunication\/makeurlrequesterror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/swiftlibscommunication\/makeurlrequesterror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/swiftlibscommunication\/makeurlrequesterror\/error-implementations","title":"Error Implementations","type":"symbol"}],"path":"\/documentation\/swiftlibscommunication\/makeurlrequesterror","title":"MakeURLRequestError","type":"enum"}],"path":"\/documentation\/swiftlibscommunication","title":"SwiftLibsCommunication","type":"module"}]},"schemaVersion":{"major":0,"minor":1,"patch":1}} |