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.5 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":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"DependencyKey"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibsdependency\/dependencykey"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency\/DependencyKey","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"This protocol defines a key to use in the dependency service."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"DependencyKey"}],"title":"DependencyKey","roleHeading":"Protocol","role":"symbol","symbolKind":"protocol","externalID":"s:19SwiftLibsDependency0C3KeyP","modules":[{"name":"SwiftLibsDependency"}],"navigatorTitle":[{"kind":"identifier","text":"DependencyKey"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency"]]},"topicSections":[{"title":"Associated Types","identifiers":["doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency\/DependencyKey\/Value"]},{"title":"Type Properties","identifiers":["doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency\/DependencyKey\/currentValue"]}],"references":{"doc://SwiftLibsDependency/documentation/SwiftLibsDependency/DependencyKey/Value":{"role":"symbol","title":"Value","fragments":[{"kind":"keyword","text":"associatedtype"},{"kind":"text","text":" "},{"kind":"identifier","text":"Value"}],"abstract":[{"type":"text","text":"The associated type representing the type of the dependency keys value."}],"identifier":"doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency\/DependencyKey\/Value","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftlibsdependency\/dependencykey\/value"},"doc://SwiftLibsDependency/documentation/SwiftLibsDependency":{"role":"collection","title":"SwiftLibsDependency","abstract":[],"identifier":"doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsdependency"},"doc://SwiftLibsDependency/documentation/SwiftLibsDependency/DependencyKey/currentValue":{"role":"symbol","title":"currentValue","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"currentValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Value"}],"abstract":[{"type":"text","text":"The default value for the dependency key."}],"identifier":"doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency\/DependencyKey\/currentValue","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftlibsdependency\/dependencykey\/currentvalue"},"doc://SwiftLibsDependency/documentation/SwiftLibsDependency/DependencyKey":{"role":"symbol","title":"DependencyKey","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"DependencyKey"}],"abstract":[{"type":"text","text":"This protocol defines a key to use in the dependency service."}],"identifier":"doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency\/DependencyKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DependencyKey"}],"url":"\/documentation\/swiftlibsdependency\/dependencykey"}}}