[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>
This commit was merged in pull request #23.
This commit is contained in:
+1
@@ -0,0 +1 @@
|
||||
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibscommunication\/mockurlrequest\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest\/!=(_:_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"role":"symbol","title":"!=(_:_:)","roleHeading":"Operator","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"symbolKind":"op","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:22SwiftLibsCommunication14MockURLRequestV","extendedModule":"Swift","modules":[{"name":"SwiftLibsCommunication"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest\/Equatable-Implementations"]]},"references":{"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLRequest/!=(_:_:)":{"role":"symbol","title":"!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest\/!=(_:_:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication\/mockurlrequest\/!=(_:_:)"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLRequest/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest\/Equatable-Implementations","kind":"article","type":"topic","url":"\/documentation\/swiftlibscommunication\/mockurlrequest\/equatable-implementations"},"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/MockURLRequest":{"role":"symbol","title":"MockURLRequest","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLRequest"}],"abstract":[{"type":"text","text":"This model includes the data to be injected into an specific URL at the time of mocking its request."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLRequest"}],"url":"\/documentation\/swiftlibscommunication\/mockurlrequest"}}}
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"variants":[{"paths":["\/documentation\/swiftlibscommunication\/mockurlrequest\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest\/Equatable-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Operators","identifiers":["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest\/!=(_:_:)"],"generated":true}],"kind":"article","metadata":{"modules":[{"name":"SwiftLibsCommunication"}],"role":"collectionGroup","title":"Equatable Implementations"},"hierarchy":{"paths":[["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest"]]},"references":{"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLRequest/!=(_:_:)":{"role":"symbol","title":"!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest\/!=(_:_:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication\/mockurlrequest\/!=(_:_:)"},"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/MockURLRequest":{"role":"symbol","title":"MockURLRequest","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLRequest"}],"abstract":[{"type":"text","text":"This model includes the data to be injected into an specific URL at the time of mocking its request."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLRequest"}],"url":"\/documentation\/swiftlibscommunication\/mockurlrequest"}}}
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"method"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPRequestMethod","preciseIdentifier":"s:22SwiftLibsCommunication17HTTPRequestMethodO","text":"HTTPRequestMethod"},{"kind":"text","text":", "},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibscommunication\/mockurlrequest\/init(method:url:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest\/init(method:url:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"method"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"HTTPRequestMethod","preciseIdentifier":"s:22SwiftLibsCommunication17HTTPRequestMethodO"},{"kind":"text","text":", "},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":")"}],"title":"init(method:url:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:22SwiftLibsCommunication14MockURLRequestV6method3urlAcA17HTTPRequestMethodO_10Foundation3URLVtcfc","modules":[{"name":"SwiftLibsCommunication"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest"]]},"references":{"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/HTTPRequestMethod":{"role":"symbol","title":"HTTPRequestMethod","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"HTTPRequestMethod"}],"abstract":[{"type":"text","text":"Enumeration that represents the available HTTP request methods to use in this library."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPRequestMethod","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"HTTPRequestMethod"}],"url":"\/documentation\/swiftlibscommunication\/httprequestmethod"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLRequest/init(method:url:)":{"role":"symbol","title":"init(method:url:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"method"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"HTTPRequestMethod","preciseIdentifier":"s:22SwiftLibsCommunication17HTTPRequestMethodO"},{"kind":"text","text":", "},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":")"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest\/init(method:url:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication\/mockurlrequest\/init(method:url:)"},"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/MockURLRequest":{"role":"symbol","title":"MockURLRequest","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLRequest"}],"abstract":[{"type":"text","text":"This model includes the data to be injected into an specific URL at the time of mocking its request."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLRequest"}],"url":"\/documentation\/swiftlibscommunication\/mockurlrequest"}}}
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"method"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPRequestMethod","preciseIdentifier":"s:22SwiftLibsCommunication17HTTPRequestMethodO","text":"HTTPRequestMethod"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibscommunication\/mockurlrequest\/method"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest\/method","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"method"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"HTTPRequestMethod","preciseIdentifier":"s:22SwiftLibsCommunication17HTTPRequestMethodO"}],"title":"method","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:22SwiftLibsCommunication14MockURLRequestV6methodAA17HTTPRequestMethodOvp","modules":[{"name":"SwiftLibsCommunication"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest"]]},"references":{"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLRequest":{"role":"symbol","title":"MockURLRequest","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLRequest"}],"abstract":[{"type":"text","text":"This model includes the data to be injected into an specific URL at the time of mocking its request."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLRequest"}],"url":"\/documentation\/swiftlibscommunication\/mockurlrequest"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLRequest/method":{"role":"symbol","title":"method","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"method"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"HTTPRequestMethod","preciseIdentifier":"s:22SwiftLibsCommunication17HTTPRequestMethodO"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest\/method","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication\/mockurlrequest\/method"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/HTTPRequestMethod":{"role":"symbol","title":"HTTPRequestMethod","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"HTTPRequestMethod"}],"abstract":[{"type":"text","text":"Enumeration that represents the available HTTP request methods to use in this library."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/HTTPRequestMethod","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"HTTPRequestMethod"}],"url":"\/documentation\/swiftlibscommunication\/httprequestmethod"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication":{"role":"collection","title":"SwiftLibsCommunication","abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication"}}}
|
||||
+1
@@ -0,0 +1 @@
|
||||
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibscommunication\/mockurlrequest\/url"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest\/url","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"title":"url","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:22SwiftLibsCommunication14MockURLRequestV3url10Foundation3URLVvp","modules":[{"name":"SwiftLibsCommunication"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest"]]},"references":{"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/MockURLRequest/url":{"role":"symbol","title":"url","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest\/url","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication\/mockurlrequest\/url"},"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/MockURLRequest":{"role":"symbol","title":"MockURLRequest","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MockURLRequest"}],"abstract":[{"type":"text","text":"This model includes the data to be injected into an specific URL at the time of mocking its request."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/MockURLRequest","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MockURLRequest"}],"url":"\/documentation\/swiftlibscommunication\/mockurlrequest"}}}
|
||||
Reference in New Issue
Block a user