Javier Cicchelli
f7235cdd28
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
4.6 KiB
JSON
1 line
4.6 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"keyPath"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WritableKeyPath","preciseIdentifier":"s:s15WritableKeyPathC"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","identifier":"doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency\/DependencyService","preciseIdentifier":"s:19SwiftLibsDependency0C7ServiceV","text":"DependencyService"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"D"},{"kind":"text","text":">)"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"keyPath","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A key path to a defined dependency in the "},{"type":"codeVoice","code":"DependencyService"},{"type":"text","text":" service."}]}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibsdependency\/dependency\/init(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency\/Dependency\/init(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Initialise the property wrapper by setting a key path to a defined dependency."}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"WritableKeyPath","preciseIdentifier":"s:s15WritableKeyPathC"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"DependencyService","preciseIdentifier":"s:19SwiftLibsDependency0C7ServiceV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"D"},{"kind":"text","text":">)"}],"title":"init(_:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:19SwiftLibsDependency0C0VyACyxGs15WritableKeyPathCyAA0C7ServiceVxGcfc","modules":[{"name":"SwiftLibsDependency"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency","doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency\/Dependency"]]},"references":{"doc://SwiftLibsDependency/documentation/SwiftLibsDependency/Dependency":{"role":"symbol","title":"Dependency","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Dependency"}],"abstract":[{"type":"text","text":"This property wrapper provides a direct connection to the "},{"type":"codeVoice","code":"DependencyService"},{"type":"text","text":" service."}],"identifier":"doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency\/Dependency","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Dependency"}],"url":"\/documentation\/swiftlibsdependency\/dependency"},"doc://SwiftLibsDependency/documentation/SwiftLibsDependency/DependencyService":{"role":"symbol","title":"DependencyService","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"DependencyService"}],"abstract":[{"type":"text","text":"This service provide write\/read access to the injected dependencies."}],"identifier":"doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency\/DependencyService","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DependencyService"}],"url":"\/documentation\/swiftlibsdependency\/dependencyservice"},"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/Dependency/init(_:)":{"role":"symbol","title":"init(_:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"WritableKeyPath","preciseIdentifier":"s:s15WritableKeyPathC"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"DependencyService","preciseIdentifier":"s:19SwiftLibsDependency0C7ServiceV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"D"},{"kind":"text","text":">)"}],"abstract":[{"type":"text","text":"Initialise the property wrapper by setting a key path to a defined dependency."}],"identifier":"doc:\/\/SwiftLibsDependency\/documentation\/SwiftLibsDependency\/Dependency\/init(_:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibsdependency\/dependency\/init(_:)"}}} |