rock-n-code/swift-libs
1
0
Fork 0
Code Issues 1 Pull Requests Releases 13 Wiki Activity

[Enhancement] DocC documentation support (#23)

Browse Source 
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:
Javier Cicchelli
2023-08-13 22:01:00 +00:00
committed by Javier Cicchelli
parent e6e82b3b40
commit f7235cdd28
1401 changed files with 5458 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/swift-libs-foundation/data/documentation/swiftlibsfoundation/bundleerror/!=(_:_:).json
+1
View File
@@ -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\/swiftlibsfoundation\/bundleerror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/!=(_:_:)","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:19SwiftLibsFoundation11BundleErrorO","extendedModule":"Swift","modules":[{"name":"SwiftLibsFoundation"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/Equatable-Implementations"]]},"references":{"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation":{"role":"collection","title":"SwiftLibsFoundation","abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/BundleError/!=(_:_:)":{"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:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/!=(_:_:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation\/bundleerror\/!=(_:_:)"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/BundleError":{"role":"symbol","title":"BundleError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"BundleError"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BundleError"}],"url":"\/documentation\/swiftlibsfoundation\/bundleerror"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/BundleError/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/Equatable-Implementations","kind":"article","type":"topic","url":"\/documentation\/swiftlibsfoundation\/bundleerror\/equatable-implementations"}}}
docs/swift-libs-foundation/data/documentation/swiftlibsfoundation/bundleerror/bundlenotfound.json
+1
View File
@@ -0,0 +1 @@
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"bundleNotFound"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibsfoundation\/bundleerror\/bundlenotfound"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/bundleNotFound","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"bundleNotFound"}],"title":"BundleError.bundleNotFound","roleHeading":"Case","role":"symbol","symbolKind":"case","externalID":"s:19SwiftLibsFoundation11BundleErrorO14bundleNotFoundyA2CmF","modules":[{"name":"SwiftLibsFoundation"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError"]]},"references":{"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/BundleError":{"role":"symbol","title":"BundleError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"BundleError"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BundleError"}],"url":"\/documentation\/swiftlibsfoundation\/bundleerror"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation":{"role":"collection","title":"SwiftLibsFoundation","abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/BundleError/bundleNotFound":{"role":"symbol","title":"BundleError.bundleNotFound","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"bundleNotFound"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/bundleNotFound","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation\/bundleerror\/bundlenotfound"}}}
docs/swift-libs-foundation/data/documentation/swiftlibsfoundation/bundleerror/equatable-implementations.json
+1
View File
@@ -0,0 +1 @@
{"variants":[{"paths":["\/documentation\/swiftlibsfoundation\/bundleerror\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/Equatable-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Operators","identifiers":["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/!=(_:_:)"],"generated":true}],"kind":"article","metadata":{"modules":[{"name":"SwiftLibsFoundation"}],"role":"collectionGroup","title":"Equatable Implementations"},"hierarchy":{"paths":[["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError"]]},"references":{"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/BundleError/!=(_:_:)":{"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:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/!=(_:_:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation\/bundleerror\/!=(_:_:)"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation":{"role":"collection","title":"SwiftLibsFoundation","abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/BundleError":{"role":"symbol","title":"BundleError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"BundleError"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BundleError"}],"url":"\/documentation\/swiftlibsfoundation\/bundleerror"}}}
docs/swift-libs-foundation/data/documentation/swiftlibsfoundation/bundleerror/error-implementations.json
+1
View File
@@ -0,0 +1 @@
{"variants":[{"paths":["\/documentation\/swiftlibsfoundation\/bundleerror\/error-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/Error-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/localizedDescription"],"generated":true}],"kind":"article","metadata":{"modules":[{"name":"SwiftLibsFoundation"}],"role":"collectionGroup","title":"Error Implementations"},"hierarchy":{"paths":[["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError"]]},"references":{"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/BundleError/localizedDescription":{"role":"symbol","title":"localizedDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/localizedDescription","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation\/bundleerror\/localizeddescription"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/BundleError":{"role":"symbol","title":"BundleError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"BundleError"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BundleError"}],"url":"\/documentation\/swiftlibsfoundation\/bundleerror"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation":{"role":"collection","title":"SwiftLibsFoundation","abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation"}}}
docs/swift-libs-foundation/data/documentation/swiftlibsfoundation/bundleerror/localizeddescription.json
+1
View File
@@ -0,0 +1 @@
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibsfoundation\/bundleerror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/localizedDescription","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Error.localizedDescription"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"role":"symbol","title":"localizedDescription","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"symbolKind":"property","externalID":"s:s5ErrorP10FoundationE20localizedDescriptionSSvp::SYNTHESIZED::s:19SwiftLibsFoundation11BundleErrorO","extendedModule":"Swift","modules":[{"name":"SwiftLibsFoundation"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError","doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/Error-Implementations"]]},"references":{"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/BundleError/Error-Implementations":{"role":"collectionGroup","title":"Error Implementations","abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/Error-Implementations","kind":"article","type":"topic","url":"\/documentation\/swiftlibsfoundation\/bundleerror\/error-implementations"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/BundleError/localizedDescription":{"role":"symbol","title":"localizedDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError\/localizedDescription","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation\/bundleerror\/localizeddescription"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation":{"role":"collection","title":"SwiftLibsFoundation","abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsfoundation"},"doc://SwiftLibsFoundation/documentation/SwiftLibsFoundation/BundleError":{"role":"symbol","title":"BundleError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"BundleError"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsFoundation\/documentation\/SwiftLibsFoundation\/BundleError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BundleError"}],"url":"\/documentation\/swiftlibsfoundation\/bundleerror"}}}