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-persistence/data/documentation/swiftlibspersistence/change/sectionupdate/!=(_:_:).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\/swiftlibspersistence\/change\/sectionupdate\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate\/!=(_:_:)","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:20SwiftLibsPersistence6ChangeO13SectionUpdateO","extendedModule":"Swift","modules":[{"name":"SwiftLibsPersistence"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence","doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change","doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate","doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate\/Equatable-Implementations"]]},"references":{"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Change/SectionUpdate":{"role":"symbol","title":"Change.SectionUpdate","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"SectionUpdate"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SectionUpdate"}],"url":"\/documentation\/swiftlibspersistence\/change\/sectionupdate"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Change/SectionUpdate/!=(_:_:)":{"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:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate\/!=(_:_:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibspersistence\/change\/sectionupdate\/!=(_:_:)"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Change/SectionUpdate/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate\/Equatable-Implementations","kind":"article","type":"topic","url":"\/documentation\/swiftlibspersistence\/change\/sectionupdate\/equatable-implementations"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence":{"role":"collection","title":"SwiftLibsPersistence","abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibspersistence"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Change":{"role":"symbol","title":"Change","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Change"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Change"}],"url":"\/documentation\/swiftlibspersistence\/change"}}}
docs/swift-libs-persistence/data/documentation/swiftlibspersistence/change/sectionupdate/deleted(_:).json
+1
View File
@@ -0,0 +1 @@
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleted"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibspersistence\/change\/sectionupdate\/deleted(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate\/deleted(_:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleted"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"title":"Change.SectionUpdate.deleted(_:)","roleHeading":"Case","role":"symbol","symbolKind":"case","externalID":"s:20SwiftLibsPersistence6ChangeO13SectionUpdateO7deletedyAESicAEmF","modules":[{"name":"SwiftLibsPersistence"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence","doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change","doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate"]]},"references":{"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Change/SectionUpdate/deleted(_:)":{"role":"symbol","title":"Change.SectionUpdate.deleted(_:)","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleted"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate\/deleted(_:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibspersistence\/change\/sectionupdate\/deleted(_:)"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence":{"role":"collection","title":"SwiftLibsPersistence","abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibspersistence"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Change/SectionUpdate":{"role":"symbol","title":"Change.SectionUpdate","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"SectionUpdate"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SectionUpdate"}],"url":"\/documentation\/swiftlibspersistence\/change\/sectionupdate"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Change":{"role":"symbol","title":"Change","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Change"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Change"}],"url":"\/documentation\/swiftlibspersistence\/change"}}}
docs/swift-libs-persistence/data/documentation/swiftlibspersistence/change/sectionupdate/equatable-implementations.json
+1
View File
@@ -0,0 +1 @@
{"variants":[{"paths":["\/documentation\/swiftlibspersistence\/change\/sectionupdate\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate\/Equatable-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Operators","identifiers":["doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate\/!=(_:_:)"],"generated":true}],"kind":"article","metadata":{"modules":[{"name":"SwiftLibsPersistence"}],"role":"collectionGroup","title":"Equatable Implementations"},"hierarchy":{"paths":[["doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence","doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change","doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate"]]},"references":{"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Change/SectionUpdate/!=(_:_:)":{"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:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate\/!=(_:_:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibspersistence\/change\/sectionupdate\/!=(_:_:)"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Change":{"role":"symbol","title":"Change","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Change"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Change"}],"url":"\/documentation\/swiftlibspersistence\/change"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence":{"role":"collection","title":"SwiftLibsPersistence","abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibspersistence"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Change/SectionUpdate":{"role":"symbol","title":"Change.SectionUpdate","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"SectionUpdate"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SectionUpdate"}],"url":"\/documentation\/swiftlibspersistence\/change\/sectionupdate"}}}
docs/swift-libs-persistence/data/documentation/swiftlibspersistence/change/sectionupdate/inserted(_:).json
+1
View File
@@ -0,0 +1 @@
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"inserted"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibspersistence\/change\/sectionupdate\/inserted(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate\/inserted(_:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"inserted"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"title":"Change.SectionUpdate.inserted(_:)","roleHeading":"Case","role":"symbol","symbolKind":"case","externalID":"s:20SwiftLibsPersistence6ChangeO13SectionUpdateO8insertedyAESicAEmF","modules":[{"name":"SwiftLibsPersistence"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence","doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change","doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate"]]},"references":{"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Change/SectionUpdate/inserted(_:)":{"role":"symbol","title":"Change.SectionUpdate.inserted(_:)","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"inserted"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate\/inserted(_:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibspersistence\/change\/sectionupdate\/inserted(_:)"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Change/SectionUpdate":{"role":"symbol","title":"Change.SectionUpdate","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"SectionUpdate"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change\/SectionUpdate","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SectionUpdate"}],"url":"\/documentation\/swiftlibspersistence\/change\/sectionupdate"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence/Change":{"role":"symbol","title":"Change","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Change"}],"abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence\/Change","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Change"}],"url":"\/documentation\/swiftlibspersistence\/change"},"doc://SwiftLibsPersistence/documentation/SwiftLibsPersistence":{"role":"collection","title":"SwiftLibsPersistence","abstract":[],"identifier":"doc:\/\/SwiftLibsPersistence\/documentation\/SwiftLibsPersistence","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibspersistence"}}}